Star webPRNT User's Manual

Star webPRNT送信エレメント


名称説明Star webPRNT
Browser		Star webPRNT
対応Star
プリンター
<root>ルートエレメント○*1○
<alignment>位置揃えエレメント○○
<barcode>バーコードエレメント○○
<bitImage>ビットイメージエレメント○○
<cutpaper>用紙カットエレメント○○
<feed>用紙送りエレメント○○
<holdprint>用紙保持制御の指定エレメント○○
<initialization>初期化エレメント○○
<logo>ロゴエレメント○○
<pdf417>PDF417エレメント○○
<peripheral>外部機器（ドロアー）エレメント○○
<qrcode>QRコードエレメント○○
<rawdata>*2生データエレメント○ *3○ *3
<ruledline>横罫線エレメント○○
<sound>ブザーエレメント○○
<sound_with_setting>メロディースピーカーエレメント○-
<text>テキストエレメント○ *4○ *4

*1 checkedblock属性は常にtrueになります。

*2 このエレメントによりプリンタ特有のコマンドを送信することができます。
  使用する場合は、プリンタ機種依存が発生する恐れがあるため、使用機種を変更する際は必ず動作確認をしてください。

*3 初期化コマンド(ESC @)は送信しないでください。その場合<initialization>(初期化エレメント)を利用してください。

*4 各機種のUTF-8対応状況は付録 UTF-8対応を参照してください。
  CodePage属性の値のうち、shift_jis,gb18030,gb2312,big5,koreaはStar webPRNT Browserのみ対応しています。
  Star webPRNT Browserをご利用の場合、UTF8に対応していないプリンターではcodepage属性をutf8に指定しないでください。

 トップへ戻る

<root>

ルートエレメント

属性

名称説明省略時
checkedblock印刷完了待ち
  • true … 印刷完了待ち有効
  • false … 印刷完了待ち無効
'true'
papertype用紙の種類
  • normal … 普通紙
  • black_mark … ブラックマーク検出有効
  • black_mark_and_detect_at_power_on … ブラックマーク検出有効＋電源投入時のブラックマーク検出動作有効
  • gap … ダイカットラベル紙等のギャップ検出有効
  • gap_and_detect_at_power_on … ダイカットラベル紙等のギャップ検出有効＋電源投入時のギャップ検出動作有効
未設定
holdprint_timeout用紙抜き取り待ちタイムアウト時間（ms）10000

値

説明
Star webPRNT送信エレメント列
例
<root>
　　<alignment position='center'/>
　　<text>Star Micronics\x0a</text>
　　<cutpaper feed='true' type='partial'/>
</root>
 トップへ戻る

<alignment>

位置揃えエレメント

属性

名称説明省略時
poistion位置揃え指定
  • 'left' … 左揃え
  • 'center' … 中央揃え
  • 'right' … 右揃え
'left'

値

説明
無視
例
<root>
　　<alignment position='center'/>
</root>
 トップへ戻る

<barcode>

バーコードエレメント

属性

名称説明省略時
symbologyシンボル
  • 'UPCE' … UPC-E
  • 'UPCA' … UPC-A
  • 'JAN8' … JAN/EAN8
  • 'JAN13' … JAN/EAN13
  • 'Code39' … Code39
  • 'ITF' … ITF
  • 'Code128' … Code128
  • 'Code93' … Code93
  • 'NW7' … NW-7
'UPCE'
width幅
  • 'width2' … 最小モジュール2ドット
  • 'width3' … 最小モジュール3ドット
  • 'width4' … 最小モジュール4ドット
  • 'width_mode1' … モード1
  • 'width_mode2' … モード2
  • 'width_mode3' … モード3
  • 'width_mode4' … モード4
  • 'width_mode5' … モード5
  • 'width_mode6' … モード6
  • 'width_mode7' … モード7
  • 'width_mode8' … モード8
  • 'width_mode9' … モード9
※コマンド仕様書参照		'width3'
height高さ（ドット単位指定）'162'
hriHRIキャラクタ
  • 'true' … HRIキャラクタあり
  • 'false' … HRIキャラクタなし
'true'

値

説明
バーコードデータ
※コマンド仕様書参照
例
<root>
　　<barcode symbology='JAN13' width='width2' hri='false' height='40'>012345678901</barcode>
</root>
 トップへ戻る

<bitImage>

ビットイメージエレメント

属性

名称説明省略時
width印刷領域幅（ドット単位指定）'0'
height印刷領域高さ（ドット単位指定）
最大値：2400		'0'

値

説明
ラスタグラフィックイメージデータ
※Base64エンコード
例
<root>
　　<bitimage width='200' height='50'>f////////////////////////////////4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYAAAAAAAA/j+AAAAAAAAAAAAAAAAAAAGAGAAAAAAAAP4/gAAAAAAAAAAAAAAAAAAHgBgAAAAAAAD+P4AAAAAAAAAAAAAAAAAAHYAYAAAAAAAA/j+AAAAAAAAAAAAAAAAAADkAGAAAAAAAAP4/gAAAAAAAAAAAAAAAAADnABgAAAAAAAD+P4AAAAAAAAAAAAAAAAADnAAYAAAH///4/j//4AAf9+AAD+HwP/fgBzAAGAAAf///+P4//+AD///+AA/h8f//4BzgABgAAP////j+P//gD////8AP4f/8ACAzgAAYAAP8AAAAAAAAAH/+A//wD+H/wAfgYwAAGAAH4AAAAAAAAAD/wAAf/A/h/AeP47OAABgAB+P///j+P//j/gf/A/4P4eB//y/4wAAYAAfD///4/j//5/h//+D/D+GD/+c8AHAAGAAH4///+P4//+/x///4f4/hD//hM/wYABgAB/B/AAD+P4AH4/8H/D+P4D/AAQ4f9gAYAAP8D/AA/j+AH8f4AP4fz+B/AAE4AH4AGAAA/4H+AP4/gB/H8AB/H8/g/gABYAAAABgAAD/4f8D+P4Afh+AAfw/P4fwAAcAAAAAYAAAH/g/g/j+AH8fwAH8Pz+F4AAEAAAAAGAAAAH/D+P4/gB/H+AB/D8/h+AAAAAAAABgAAAAf4fz+P8Af4/4Gfw/P4fgAAAAAAAAYAAf///j8/j//z+H//n8Pz+H4AAAAAAAAGAAH///w/PYX/8f49/Z3D8/h+AAAAAAAABgAB///8Pz/B//D/B/+fw/P4fgAAAAAAAAYAAAAAAH8f8AAAf+AAH8Pz+H4AAAAAAAAGAAAAAAP+D/8AAD/+AB/D8/h+AAAAAAAABgAB////+AP///AH//+fw/P4fgAAAAAAAAYAAf///+AAf//wAf//n8Pz+H4AAAAAAAAGAAH///4AAAf/8AAf/x/D8/h+AAAAAAAABgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAYAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAf////////////////////////////////8
=</bitimage>
</root>
 トップへ戻る

<cutpaper>

用紙カットエレメント

属性

名称説明省略時
typeカット種
  • 'full' … フルカット
  • 'partial' … パーシャルカット
'full'
feedカット前の用紙送り
  • 'true' … 用紙送りあり
  • 'false' … 用紙送りなし
'true'

値

説明
無視
例
<root>
　　<cutpaper feed='true' type='partial'/>
</root>
 トップへ戻る

<feed>

用紙送りエレメント

属性

名称説明省略時
line行単位紙送り量（行単位指定）'0'
unitドット単位紙送り量（ドット単位指定）'0'

値

説明
無視
例
<root>
　　<feed line='2' unit='8'/>
</root>
 トップへ戻る

<holdprint>

Star webPRNTによる用紙保持制御の指定エレメント

属性

名称説明省略時
type 用紙保持制御
  • 'valid' … 有効
  • 'invalid' … 無効
  • 'default' … プリンター設定（メモリスイッチ設定）に従う
 'default'

値

説明
無視
例
<root>
　　<alignment position='center'/>
　　<holdprint type='valid'/>
　　<text>Star Micronics\x0a</text>
　　<cutpaper feed='true' type='partial'/>
</root>
本機能を有効にした場合、次の印刷をしようとしたときに、用紙抜き取り待ちタイムアウト時間経過後に用紙が抜き取られていない場合、印刷が失敗します。 用紙抜き取り待ちタイムアウト時間は、StarWebPrintTraderのholdprint_timeoutプロパティにて設定可能です。 また、StarWebPrintTraderのisPaperPresentのステータスを確認することで、本機能によって印刷が失敗したかどうかを判定することができます。
 トップへ戻る

<initialization>

初期化エレメント

属性

名称説明省略時
resetハードウェアリセット
  • 'true' … ハードウェアリセット実施
  • 'false' … ハードウェアリセット未実施（コマンドの初期化のみ）
'false'
printハードウェアリセット後の自己印字
  • 'true' …ハードウェアリセット後の自己印字実施
  • 'false' … ハードウェアリセット後の自己印字未実施
'false'

値

説明
無視
例
<root>
　　<initialization reset='false' print='false'/>
</root>
 トップへ戻る
 トップへ戻る

<pdf417>

PDF417エレメント

属性

名称説明省略時
lineライン数
※コマンド仕様書参照		'0'
columnカラム数
※コマンド仕様書参照		'0'
levelセキュリティレベル
  • 'level0' … セキュリティレベル0
  • 'level1' … セキュリティレベル1
  • 'level2' … セキュリティレベル2
  • 'level3' … セキュリティレベル3
  • 'level4' … セキュリティレベル4
  • 'level5' … セキュリティレベル5
  • 'level6' … セキュリティレベル6
  • 'level7' … セキュリティレベル7
  • 'level8' … セキュリティレベル8
'level1'
moduleモジュールサイズ（ドット単位指定）'2'
aspectアスペクト比'3'

値

説明
PDF417データ
※コマンド仕様書参照
例
<root>
　　<pdf417 level='level1' line='0' column='0' module='2' aspect='3'>http://www.starmicronics.com/</pdf417>
</root>
 トップへ戻る

<peripheral>

外部機器（ドロアー）エレメント

属性

名称説明省略時
channel外部機器（ドロアー）
  • '1' … チャンネル1番
  • '2' … チャンネル2番（通電時間/ディレイ時間無効）
'1'
on通電時間（1mSec単位指定）'200'
offディレイ時間（1mSec単位指定）'200'

値

説明
無視
例
<root>
　　<peripheral channel='1' on='200' off='200'/>
</root>
 トップへ戻る

<qrcode>

QRコードエレメント

属性

名称説明省略時
modelモデル
  • 'model1' … モデル1
  • 'model2' … モデル2
'model2'
level誤り訂正レベル
  • 'level_l' … 誤り訂正レベルL
  • 'level_m' … 誤り訂正レベルM
  • 'level_q' … 誤り訂正レベルQ
  • 'level_h' … 誤り訂正レベルH
'level_l'
cellセルサイズ（ドット単位指定）'3'

値

説明
QRコードデータ
※コマンド仕様書参照
例
<root>
　　<qrcode model='model2' level='level_l' cell='3'>http://www.starmicronics.com/</qrcode>
</root>
 トップへ戻る

<rawdata>

生データエレメント

属性

名称説明省略時
---

値

説明
生データ
※Base64エンコード
例
<root>
　　<rawdata>MTIzNDU=</rawdata>
</root>
  • このメソッドによりプリンタ特有のコマンドを送信することができます。
  • 使用する場合は、プリンタ機種依存が発生する恐れがあるため、使用機種を変更する際は必ず動作確認をしてください。
 トップへ戻る

<ruledline>

横罫線エレメント

属性

名称説明省略時
thickness線種
  • 'thin' … 細線
  • 'medium' … 中線
  • 'thick' … 太線
  • 'double_thin' … 二重細線
  • 'double_medium' … 二重中線
  • 'double_thick' … 二重太線
'medium'
width長さ（ドット単位指定）'832'

値

説明
無視
例
<root>
　　<ruledline thickness='thin' width='200'/>
</root>
 トップへ戻る

<sound>

ブザーエレメント

属性

名称説明省略時
channel外部機器（ブザー）
  • '1' … チャンネル1番
  • '2' … チャンネル2番
'1'
repeat繰り返し回数'1'

値

説明
無視
例
<root>
　　<sound channel='1' repeat='1'/>
</root>
Note: ブザー以外を接続して本エレメントを使用しないでください。 正常動作しない場合や、プリンターおよび外部機器本体が破損する恐れがあります。
 トップへ戻る

<sound_with_setting>

メロディースピーカーエレメント

属性

名称説明省略時
sound_storage_areaサウンド格納領域
  • 1 … サウンド格納領域1
  • 2 … サウンド格納領域2
mC-Sound本体のDIPスイッチ設定に従う
sound_numberサウンド番号
  • 0 … サウンド番号０
  • 1 … サウンド番号１
  • 2 … サウンド番号2
  • 3 … サウンド番号3
  • 4 … サウンド番号4
  • 5 … サウンド番号5
  • 6 … サウンド番号6
  • 7 … サウンド番号7
mC-Sound本体のDIPスイッチ設定に従う
volume音量
  • 'volume0' … 音量０（無音）
  • 'volume1' … 音量１（最小）
  • 'volume2' … 音量2
  • 'volume3' … 音量3
  • 'volume4' … 音量4
  • 'volume5' … 音量5
  • 'volume6' … 音量6
  • 'volume7' … 音量7
  • 'volume8' … 音量8
  • 'volume9' … 音量9
  • 'volume10' … 音量10
  • 'volume11' … 音量11
  • 'volume12' … 音量12
  • 'volume13' … 音量13
  • 'volume14' … 音量14
  • 'volume15' … 音量15（最大）
  • 'volume_off' … 無音
  • 'volume_min' … 音量最小
  • 'volume_max' … 音量最大
mC-Sound本体のDIPスイッチ設定に従う

値

説明
無視
例
<root>
　　<sound_with_setting sound_storage_area='1' sound_number='0' volume='volume6'/>
</root>
Note: メロディースピーカー以外を接続して本エレメントを使用しないでください。 正常動作しない場合や、プリンターおよび外部機器本体が破損する恐れがあります。
 トップへ戻る

<text>

テキストエレメント

属性

名称説明省略時
codepageコードページ
  • 'utf8' … UTF-8
  • 'cp437' … コードページ437
  • 'cp737' … コードページ737
  • 'cp772' … コードページ772
  • 'cp774' … コードページ774
  • 'cp851' … コードページ851
  • 'cp852' … コードページ852
  • 'cp855' … コードページ855
  • 'cp857' … コードページ857
  • 'cp858' … コードページ858
  • 'cp860' ～ 'cp866' … コードページ860 ～ 866
  • 'cp869' … コードページ869
  • 'cp874' … コードページ874
  • 'cp928' … コードページ928
  • 'cp932' … コードページ932(Katakana)
  • 'cp998' … コードページ998(Normal)
  • 'cp999' … コードページ999
  • 'cp1001' … コードページ1001
  • 'cp1250' ～ 'cp1252' … コードページ1250 ～ 1252
  • 'cp2001' … コードページ2001
  • 'cp3001' … コードページ3001
  • 'cp3002' … コードページ3002
  • 'cp3011' … コードページ3011
  • 'cp3012' … コードページ3012
  • 'cp3021' … コードページ3021
  • 'cp3041' … コードページ3041
  • 'cp3840' … コードページ3840
  • 'cp3841' … コードページ3841
  • 'cp3843' ～ 'cp3848' … コードページ3843 ～ 3848
  • 'blank' … ユーザ設定（空白コードページ)
  • 'shift_jis' … Shift_JIS
  • 'gb18030' … GB18030
  • 'gb2312' … GB2312
  • 'big5' … Big5
  • 'korea' … korea
未設定
international国際文字
  • 'usa' … USA
  • 'france' … フランス
  • 'germany' … ドイツ
  • 'uk' … イギリス
  • 'denmark' … デンマーク
  • 'sweden' … スウェーデン
  • 'italy' … イタリア
  • 'spain' … スペイン
  • 'japan' … 日本
  • 'norway' … ノルウェー
  • 'denmark2' … デンマークⅡ
  • 'spain2' … スペインⅡ
  • 'latin_america' … ラテンアメリカ
  • 'korea' … 韓国
  • 'ireland' … アイルランド
  • 'legal' … リーガル
未設定
characterspace文字間スペース（ドット単位指定）未設定
emphasis強調印字
  • 'true' … 強調印字有効
  • 'false' … 強調印字無効
未設定
invert白黒反転印字
  • 'true' … 白黒反転印字有効
  • 'false' … 白黒反転印字無効
未設定
linespace行間スペース（ドット単位指定）
  • 24 … 3mm改行
  • 32 … 4mm改行
未設定
width横倍率
  • 1 … 等倍幅
  • 2 … 2倍幅
  • 3 … 3倍幅
  • 4 … 4倍幅
  • 5 … 5倍幅
  • 6 … 6倍幅
未設定
height縦倍率
  • 1 … 等倍高
  • 2 … 2倍高
  • 3 … 3倍高
  • 4 … 4倍高
  • 5 … 5倍高
  • 6 … 6倍高
未設定
fontフォント種
  • 'font_a' … フォントA（12×24ドット）
  • 'font_b' … フォントB（9×24ドット）
未設定
undelline下線印字
  • 'true' … 下線印字有効
  • 'false' … 下線印字無効
未設定

値

説明
テキストデータ
例
<root>
　　<text codepage='cp998' international='usa' characterspace='0' emphasis='false' invert='false' linespace='32' width='1' height='1' font='font_a' underline='false'>Star Micronics\x0a</text>
</root>
 トップへ戻る