Class Document

Document クラスは、ファイルまたはストリームからドキュメントを開き、 正しい ICpDocument クラスを取得するための helper/factory メソッドを提供します。

Inheritance

System.Object

Document

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: StarMicronics.CloudPrnt

Assembly: cs.temp.dll.dll

Syntax

public static class Document

Methods

Convert(Byte[], String, Stream, String, ConversionOptions)

印刷ジョブデータを、指定された入力byte配列バッファとメディア形式から 要求された出力ストリームとメディア形式に変換します。

Declaration

public static void Convert(byte[] inputBuffer, string inputType, Stream outputStream, string outputType, ConversionOptions options)

Parameters

Type	Name	Description
System.Byte[]	inputBuffer	入力byte配列バッファ
System.String	inputType	IANA/MIME形式のメディアタイプとして指定される入力データのタイプ
System.IO.Stream	outputStream	変換された出力データが格納されるStreamオブジェクト
System.String	outputType	IANA/MIME形式のメディアタイプとして指定される出力データのタイプ
ConversionOptions	options	変換パラメーターと出力結果を指定するための変換オプション

Convert(Stream, String, Stream, String, ConversionOptions)

印刷ジョブデータを、指定された入力ストリームとメディア形式から 要求された出力ストリームとメディア形式に変換します。

Declaration

public static void Convert(Stream inputStream, string inputType, Stream outputStream, string outputType, ConversionOptions options)

Parameters

Type	Name	Description
System.IO.Stream	inputStream	入力データが格納されたStreamオブジェクト
System.String	inputType	IANA/MIME形式のメディアタイプとして指定される入力データのタイプ
System.IO.Stream	outputStream	変換された出力データが格納されるStreamオブジェクト
System.String	outputType	IANA/MIME形式のメディアタイプとして指定される出力データのタイプ
ConversionOptions	options	変換パラメーターと出力結果を指定するための変換オプション

ConvertFile(String, Stream, String, ConversionOptions)

ロードされたファイルを必要に応じて変換し、 要求された出力ストリームとメディア形式に変換します。 入力データフォーマットはファイル名の拡張子を基に決定されます。

Declaration

public static void ConvertFile(string fileName, Stream outputStream, string outputType, ConversionOptions options)

Parameters

Type	Name	Description
System.String	fileName	入力ファイル名
System.IO.Stream	outputStream	変換された出力データが格納されるStreamオブジェクト
System.String	outputType	IANA/MIME形式のメディアタイプとして指定される出力データのタイプ
ConversionOptions	options	変換パラメーターと出力結果を指定するための変換オプション

ConvertFile(String, String, Stream, String, ConversionOptions)

ロードされたファイルを必要に応じて変換し、 要求された出力ストリームとメディア形式に変換します。

Declaration

public static void ConvertFile(string fileName, string inputType, Stream outputStream, string outputType, ConversionOptions options)

Parameters

Type	Name	Description
System.String	fileName	入力ファイル名
System.String	inputType	IANA/MIME形式のメディアタイプとして指定される入力データのタイプ
System.IO.Stream	outputStream	変換された出力データが格納されるStreamオブジェクト
System.String	outputType	IANA/MIME形式のメディアタイプとして指定される出力データのタイプ
ConversionOptions	options	変換パラメーターと出力結果を指定するための変換オプション

GetDocument(Byte[], String)

ICpDocumentのタイプを決定するための指定されたmediaTypeを使用して、 入力されたbyte配列バッファに基づいてICpDocumentオブジェクトを生成します。

サポートされているmediaType:

Media Type String	File Format
image/bmp	BMP互換のイメージデータ。戻り値でImageDocオブジェクトが返されます。
image/png	PNG互換のイメージデータ。戻り値でImageDocオブジェクトが返されます。
image/jpeg	Jpeg互換のイメージデータ。戻り値でImageDocオブジェクトが返されます。
image/gif	Gif互換のイメージデータ。戻り値でImageDocオブジェクトが返されます。
text/plain	UTF8/Asciiプレーンテキストデータ。戻り値でTextDocオブジェクトが返されます。
text/vnd.star.markup	Star Document Markup 制御を含むUTF8エンコードされたテキストデータ。戻り値でMarkupDocオブジェクトが返されます。

入力データは、inputDataの読み取り位置からデコード可能な入力データの終端まで（決定できる場合）、 またはinputDataの終端までになります。

Declaration

public static ICpDocument GetDocument(byte[] inputData, string mediaType)

Parameters

Type	Name	Description
System.Byte[]	inputData	ICpDocumentにデコードされるbyte配列データ
System.String	mediaType	IANA/MIME形式の入力データのメディアタイプ

Returns

Type	Description
ICpDocument	。必要に応じた変換を含め、CloudPRNTを介した印刷用の入力ファイルを準備するために 使用されるICpDocumentを実装するオブジェクトが返されます。

Examples

簡単なStar Document Markupの入力に基づくICpDocumentオブジェクトを生成するサンプル

    StringBuilder job = new StringBuilder();
    job.Append("Hello World!\n");
    job.Append("[barcode: type code39; data 12345; height 10mm]\n");
    job.Append("[cut]");

    byte[] data = Encoding.UTF8.GetBytes(job.ToString());

    ICpDocument doc = Document.GetDocument(data, "text/vnd.star.markup");

GetDocument(Stream, String)

ICpDocumentのタイプを決定するための指定されたmediaTypeを使用して、 Streamオブジェクトに基づいてICpDocumentオブジェクトを生成します。

サポートされているmediaType:

Media Type String	File Format
image/bmp	BMP互換のイメージデータ。戻り値でImageDocオブジェクトが返されます。
image/png	PNG互換のイメージデータ。戻り値でImageDocオブジェクトが返されます。
image/jpeg	Jpeg互換のイメージデータ。戻り値でImageDocオブジェクトが返されます。
image/gif	Gif互換のイメージデータ。戻り値でImageDocオブジェクトが返されます。
text/plain	UTF8/Asciiプレーンテキストデータ。戻り値でTextDocオブジェクトが返されます。
text/vnd.star.markup	Star Document Markup 制御を含むUTF8エンコードされたテキストデータ。戻り値でMarkupDocオブジェクトが返されます。

入力データは、inputStreamの読み取り位置からデコード可能な入力データの終端まで（決定できる場合）、 またはStreamの終端までになります。

Declaration

public static ICpDocument GetDocument(Stream inputStream, string mediaType)

Parameters

Type	Name	Description
System.IO.Stream	inputStream	読み込み可能なStreamオブジェクト
System.String	mediaType	IANA/MIME形式の入力データのメディアタイプ

Returns

Type	Description
ICpDocument	。必要に応じた変換を含め、CloudPRNTを介した印刷用の入力ファイルを準備するために 使用されるICpDocumentを実装するオブジェクトが返されます。

GetDocumentFromFile(String)

入力ファイルに基づいてICpDocumentオブジェクトを生成します。 ICpDocumentオブジェクトのタイプは入力されたファイル名の拡張子で決定されます。

認識可能なfilenameの拡張子:

Media Type String	File Format
.bmp	BMP互換のイメージファイル。戻り値でImageDocオブジェクトが返されます。
.png	PNG互換のイメージファイル。戻り値でImageDocオブジェクトが返されます。
.jpg	Jpeg互換のイメージファイル。戻り値でImageDocオブジェクトが返されます。
.jpeg	Jpeg互換のイメージファイル。戻り値でImageDocオブジェクトが返されます。
.gif	Gif互換のイメージファイル。戻り値でImageDocオブジェクトが返されます。
.txt	UTF8エンコードのプレーンテキストデータファイル。戻り値でTextDocオブジェクトが返されます。
.stm	Star Document Markup 制御を含むUTF8エンコードされたテキストファイル。戻り値でMarkupDocオブジェクトが返されます。

Declaration

public static ICpDocument GetDocumentFromFile(string filename)

Parameters

Type	Name	Description
System.String	filename	有効な拡張子付きの入力ファイル名

Returns

Type	Description
ICpDocument	。必要に応じた変換を含め、CloudPRNTを介した印刷用の入力ファイルを準備するために 使用されるICpDocumentを実装するオブジェクトが返されます。

Examples

入力イメージファイルからImageDocオブジェクトを生成するサンプル

ICpDocument doc = Document.GetDocumentFromFile("source.jpg");

GetDocumentFromFile(String, String)

ICpDocumentのタイプを決定するための指定されたmediaTypeを使用して、 入力ファイルに基づいてICpDocumentオブジェクトを生成します。

サポートされているmediaType:

Media Type String	File Format
image/bmp	BMP互換のイメージファイル。戻り値でImageDocオブジェクトが返されます。
image/png	PNG互換のイメージファイル。戻り値でImageDocオブジェクトが返されます。
image/jpeg	Jpeg互換のイメージファイル。戻り値でImageDocオブジェクトが返されます。
image/gif	Gif互換のイメージファイル。戻り値でImageDocオブジェクトが返されます。
text/plain	UTF8/Asciiプレーンテキストファイル。戻り値でTextDocオブジェクトが返されます。
text/vnd.star.markup	Star Document Markup 制御を含むUTF8エンコードされたテキストデータ。戻り値でMarkupDocオブジェクトが返されます。

Declaration

public static ICpDocument GetDocumentFromFile(string filename, string mediaType)

Parameters

Type	Name	Description
System.String	filename	入力ファイル名
System.String	mediaType	IANA/MIME形式の入力ファイルのメディアタイプ

Returns

Type	Description
ICpDocument	。必要に応じた変換を含め、CloudPRNTを介した印刷用の入力ファイルを準備するために 使用されるICpDocumentを実装するオブジェクトが返されます。

Examples

入力イメージファイルと指定したmediaTypeからImageDocオブジェクトを生成するサンプル

ICpDocument doc = Document.GetDocumentFromFile("source.jpg", "image/jpeg");

GetOutputTypesFromFileName(String)

指定されたfileNameによって決定される入力タイプに対して、サポートされている出力メディアタイプのリストを取得します。 入力タイプが指定されたfileNameの拡張子によって判断できる場合に出力メディアタイプのリストが通知されます。 また、ファイルを開いたり、読み込んだり、修正したり存在確認をすることはありません。

Declaration

public static string[] GetOutputTypesFromFileName(string fileName)

Parameters

Type	Name	Description
System.String	fileName	入力ファイル名

Returns

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

Examples

CloudPRNT POST（ポール）リクエストの処理時、Star Document Markup形式で準備する場合の 印刷ジョブの出力準備(メディアタイプ含む)ができていることをクライアントに通知するサンプル

    CpMessage.PollResponse response = new CpMessage.PollResponse();
    response.jobReady = true;
    response.mediaTypes = new List<string>();
    response.mediaTypes.AddRange(Document.GetOutputTypesFromFieName("test.png"));

GetOutputTypesFromType(String)

入力されたタイプに対応する出力メディアタイプのリストを取得する

Declaration

public static string[] GetOutputTypesFromType(string sourceMediaType)

Parameters

Type	Name	Description
System.String	sourceMediaType	IANA/MIME形式のメディアタイプ

Returns

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

Examples

CloudPRNT POST（ポール）リクエストを処理する際に、 印刷ジョブが Star Document Markup 形式で準備された場合に、 準備可能なメディアタイプをクライアントに通知するサンプル

    CpMessage.PollResponse response = new CpMessage.PollResponse();
    response.jobReady = true;
    response.mediaTypes = new List<string>();
    response.mediaTypes.AddRange(Document.GetOutputTypesFromType("text/vnd.star.markup"));