StarXpand SDK for Native Manual

カスタマーディスプレイを使う

手順や参照先はOSによって異なります。表示するOSを選択してください。

カスタマーディスプレイを使う処理について、StarPRNT SDKとStarXpand SDKの構成を説明します。

両SDKの違いを確認しStarXpand SDKへの移行を行ってください。

StarPRNT SDK

プリンターに接続されているカスタマーディスプレイを制御するには、ISDCBBuilderクラスを使用して制御コマンドを生成します。
文字を表示するには、このクラスのappendBytes()メソッドで文字データを追加する必要があります。この時Stringではなく以下のように文字コードの値を指定する必要があります。

let pattern: [UInt8] = [0x48, 0x65, 0x6c, 0x6c, 0x6f]   // 表示データ: "Hello"
builder.appendBytes(pattern, length: UInt(pattern.count))

それ以外の機能については、ISDCBBuilderをご参照ください。最後にpassThroughCommandsプロパティから制御コマンドを取得し、SMPortクラスのwrite()メソッドでプリンターに送信します。

StarXpand SDK

カスタマーディスプレイに文字列を表示するには、DocumentBuilderクラスのaddDisplay()メソッドを使用し、ディスプレイに文字列を表示する指示をドキュメントに追加します。ディスプレイに表示する文字列はDisplayBuilderクラスのactionShowText()メソッドの引数にString型の値で指定することができます。
DisplayBuilderの他の機能については、DisplayBuilderをご参照ください。
最後に印刷データと同様、StarXpandCommandBuilderクラスのgetCommands()メソッドでディスプレイを制御するデータを取得し、StarPrinterクラスのprint()メソッドでプリンターに送信します。

各APIのStarPRNT SDKとStarXpand SDKへの対応状況は、対応API一覧をご確認ください。

カスタマーディスプレイを使う処理について、StarPRNT SDKとStarXpand SDKの構成を説明します。

両SDKの違いを確認しStarXpand SDKへの移行を行ってください。

StarPRNT SDK

プリンターに接続されているカスタマーディスプレイを制御するには、IDisplayCommandBuilderクラスを使用して制御コマンドを生成します。
文字を表示するには、このクラスのappendBytes()メソッドで文字データを追加する必要があります。この時Stringではなく以下のように文字コードの値を指定する必要があります。

val pattern = byteArrayOf(0x48, 0x65, 0x6c, 0x6c, 0x6f)  // 表示データ: "Hello"
builder.appendBytes(pattern, pattern.size)

それ以外の機能については、IDisplayCommandBuilderをご参照ください。
最後にgetPassThroughCommands()メソッドから制御コマンドを取得し、StarIOPortクラスのwritePort()メソッドでプリンターに送信します。

StarXpand SDK

カスタマーディスプレイに文字列を表示するには、印刷データを作成するで使用した、DocumentBuilderクラスのaddDisplay()メソッドを使用し、ディスプレイに文字列を表示する指示をドキュメントに追加します。ディスプレイに表示する文字列はDisplayBuilderクラスのactionShowText()メソッドの引数にString型の値で指定することができます。
DisplayBuilderの他の機能については、DisplayBuilderをご参照ください。
最後に印刷データと同様、StarXpandCommandBuilderクラスのgetCommands()メソッドでディスプレイを制御するデータを取得し、StarPrinterクラスのprintAsync()メソッドでプリンターに送信します。

各APIのStarPRNT SDKとStarXpand SDKへの対応状況は、対応API一覧をご確認ください。