UniPRT SDK  v1.0.0.0
UniPRT.Sdk.Settings.SettingsReadWrite类 参考

支持读取和写入印表机设置。 更多...

类 UniPRT.Sdk.Settings.SettingsReadWrite 继承关系图:
UniPRT.Sdk.Settings.ISettingsReadWrite

Public 成员函数

 SettingsReadWrite (IComm connection)
 必须传递一个已打开的 comm 连接,该连接可以保持打开状态以监听未请求的印表机讯息。 更多...
 
 SettingsReadWrite (string commDescriptor)
 当创建由 SDK 管理的连接时调用的构造函数。 更多...
 
void Dispose ()
 
Dictionary< string, SettingGetAllProperties ()
 继承自 ISettingsReadWrite.GetAllProperties。
 
Dictionary< string, string > GetAllValues ()
 继承自 ISettingsReadWrite.GetAllValues。
 
Dictionary< string, SettingGetProperties (List< string > keys)
 继承自 ISettingsReadWrite.GetProperties。
 
Setting GetProperties (string key)
 继承自 ISettingsReadWrite.GetProperties。
 
string GetValue (string key)
 继承自 ISettingsReadWrite.GetValue。
 
Dictionary< string, string > GetValues (List< string > keys)
 继承自 ISettingsReadWrite.GetValues。
 
bool SetValue (string keyToSet, string valueToSet)
 继承自 ISettingsReadWrite.SetValue。
 
bool SetValues (Dictionary< string, string > keysToSet)
 继承自 ISettingsReadWrite.SetValues。
 

Protected 成员函数

virtual void Dispose (bool disposing)
 

详细描述

支持读取和写入印表机设置。

For list of valid keys and values refer to: Settings Key/Value Items

示例


using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using UniPRT.Sdk.Comm;
namespace Snippets
{
class MySettings
{
public static void MainSettings(string[] args)
{
IComm ptrComm;
ptrComm = new TcpConnection("192.168.1.50", TcpConnection.DEFAULT_MGMT_PORT);
ptrComm.Open();
Console.WriteLine(Environment.NewLine+ "Reading some settings..." + Environment.NewLine);
ReadSomePrinterSettings(ptrComm);
Console.WriteLine(Environment.NewLine + "Making Setting Changes..." + Environment.NewLine);
ChangePrinterSettings(ptrComm);
ptrComm.Close();
}
public static void ReadSomePrinterSettings(IComm ptrComm)
{
try
{
if (null != ptrComm)
{
if (!ptrComm.Connected)
{
Console.WriteLine("Error: no connection");
return;
}
SettingsReadWrite mySettings = new SettingsReadWrite(ptrComm);
// Read individual settings if needed
Console.WriteLine($"LCD Units: '{mySettings.GetValue("LCD.LabelUnits")}'");
Console.WriteLine($"Printer Resolution: '{mySettings.GetValue("Printer.Head.DPI-d")}'");
Console.WriteLine($"LCD Language: '{mySettings.GetValue("LCD.Language")}'");
// read list of settings
Console.WriteLine();
Console.WriteLine("Reading label settings:");
Dictionary<string, string> contentList = mySettings.GetValues(
new List<string>() {
"Handling.Type",
"Image.Length-in",
"Image.Width-in",
"Image.Clip-b",
"Label.Sensor" });
foreach (KeyValuePair<string, string> item in contentList)
{
Console.WriteLine($"\"{item.Key}\" = {item.Value}");
}
mySettings.Dispose();
}
}
catch (Exception err)
{
Console.WriteLine($"Error: {err}");
}
}
public static void ChangePrinterSettings(IComm ptrComm)
{
try
{
if (null != ptrComm)
{
if (!ptrComm.Connected)
{
Console.WriteLine("Error: no connection");
return;
}
SettingsReadWrite mySettings = new SettingsReadWrite(ptrComm);
// Change units displayed on LCD
// LCD.MediaUnits can be: eInches, eMetric
mySettings.SetValue("LCD.MediaUnits", "\"eInches\"");
mySettings.SetValue("Image.Length-in", "4.3");
// Change list of settings
// Handling.Type can be: eContinuous, eCut, ePeelOff, eTearOff, eTearOffStrip
// Label.Sensor can be: eDisable, eMark, eGap, eAdvNotch, eAdvGap,
Dictionary<string, string> setKeys =
new Dictionary<string, string>() {
{ "Handling.Type", "\"eContinuous\"" },
{ "Image.Clip-b", "false" },
{ "Label.Sensor", "\"eGap\"" } };
if (mySettings.SetValues(setKeys))
{
Console.WriteLine("Setvalues SUCCESS.");
}
else
{
Console.WriteLine("Setvalues failed.");
}
Console.WriteLine();
Console.WriteLine("Settings read after changes made:");
Dictionary<string, string> contentList = mySettings.GetValues(new List<string>(setKeys.Keys));
foreach (KeyValuePair<string, string> item in contentList)
{
Console.WriteLine($"\"{item.Key}\" = {item.Value}");
}
mySettings.Dispose();
}
}
catch (Exception err)
{
Console.WriteLine($"Error: {err}");
}
}
}
}

构造及析构函数说明

◆ SettingsReadWrite() [1/2]

UniPRT.Sdk.Settings.SettingsReadWrite.SettingsReadWrite ( IComm  connection)

必须传递一个已打开的 comm 连接,该连接可以保持打开状态以监听未请求的印表机讯息。

必须有连接才能发送/接收印表机状态讯息。

◆ SettingsReadWrite() [2/2]

UniPRT.Sdk.Settings.SettingsReadWrite.SettingsReadWrite ( string  commDescriptor)

当创建由 SDK 管理的连接时调用的构造函数。

commDescriptor 是用于与印表机连接的通信描述符。
TCP 描述符格式:"ip" 或 "ip:port"
例如:"127.0.0.1" 或 "127.0.0.1:3007"
如果未提供端口,则使用默认值。

UniPRT.Sdk.Settings
Definition: Configs.cs:11
UniPRT
提供对不同通信接口/端口的支持
Definition: Communication.cs:9
UniPRT.Sdk.Settings.SettingsReadWrite.SettingsReadWrite
SettingsReadWrite(IComm connection)
必须传递一个已打开的 comm 连接,该连接可以保持打开状态以监听未请求的印表机讯息。
Definition: SettingsReadWrite.cs:510
UniPRT.Sdk.Comm
Definition: Communication.cs:9
UniPRT.Sdk
Definition: Communication.cs:9