MarkupDoc

Starマークアップランゲージのドキュメントを処理する ICpDocument インターフェイスの実装クラスを表します。

Starマークアップランゲージは、ビット画像データとプレーンテキストデータを組みあわせてドキュメントを定義でき、 テキストの装飾/スケーリング、バーコード印刷、オートカッター、およびその他のPOSプリンター固有の機能を制御できます。

また、Starマークアップは自動ワードラッピングとカラムレイアウトを提供することにより、複数の用紙サイズのサポートを可能にします。

NameSpace: StarMicronics.CloudPrnt.Documents

Syntax

public class MarkupDoc : ICpDocument

Constructors

MarkupDoc(Stream)

Star Markup形式を含む入力StreamソースからMarkupDocオブジェクトを構築します。

Streamオブジェクトは、BOM無しのUTF-8かASCIIでエンコードされたデータを提供する必要があります。

データは、Streamオブジェクトの現在位置から終端までロードされます。

Declaration

public MarkupDoc(Stream input)

Parameters

Type	Name	Description
System.IO.Stream	input	データのロード元のStreamオブジェクト

MarkupDoc(String)

Star Markup形式のデータを含む外部テキストファイルから新しいMarkupDocオブジェクトを構築します。

BOM無しのUTF-8かASCIIエンコードされたソースファイルを指定してください。

Declaration

public MarkupDoc(string fileName)

Parameters

Type	Name	Description
System.String	fileName	入力ソースのファイル名

Properties

JobConversionOptions

ドキュメントを要求されたメディア形式に変換し、指定されたSteamオブジェクトに書き込みます。

Declaration

public ConversionOptions JobConversionOptions { get; set; }

Property Value

Type	Description
ConversionOptions	ジョブ形式変換を実行するときに使用されるオプション設定

NativeFormat

このドキュメントの作成に使用されたIANA / MIMEメディアタイプ形式の入力ドキュメント形式を返します。

MarkupDocオブジェクトの場合、常に"text/vnd.star.markup"を返します。

Declaration

public string NativeFormat { get; }

Property Value

Type	Description
System.String	MarkupDocオブジェクトは常に"text/vnd.star.markup"を返します。

OutputFormats

このドキュメントから変換出力可能なメディアタイプのリストを提供します。

Declaration

public string[] OutputFormats { get; }

Property Value

Type	Description
System.String[]	IANA / MIMEメディアタイプ形式のサポートされている出力形式のリスト

Methods

convertTo(String, Stream)

ドキュメントを要求されたメディア形式に変換し、指定されたSteamオブジェクトに書き込みます。

Declaration

public void convertTo(string requestFormat, Stream outStream)

Parameters

Type	Name	Description
System.String	requestFormat	IANA / MIME形式のメディアタイプとして指定された出力形式で、 OutputFormatsプロパティでリストされている(MarkupDocオブジェクトによる出力でサポートされている)形式でなければなりません。
System.IO.Stream	stream	出力データが書き込まれるStreamオブジェクト