MarkupUtil

MarkupUtil class provides static methods for converting Star document markup into printer commands.

This class is a wrapper class for the Document class.

NameSpace: StarMicronics.StarDocumentMarkup

Syntax

public static class MarkupUtil

Methods

Render(Byte[], StarPrinterEmulation, ConversionOptions)

Inputs the Star document markup in a byte array buffer and converts it into printer commands for the specified emulation.

Declaration

public static Stream Render(byte[] inputBuffer, StarPrinterEmulation outputEmulation, ConversionOptions options)

Parameters

Type	Name	Description
System.Byte[]	inputBuffer	Input data buffer (Star Document Markup)
StarPrinterEmulation	outputEmulation	Printer emulation to be specified as the destination
ConversionOptions	options	Conversion options to specify conversion parameters and output results.

Returns

Type	Description
System.IO.Stream	The printer commands for the specified emulation.

Render(Stream, StarPrinterEmulation, ConversionOptions)

Inputs the Star document markup in a Stream and converts it into printer commands for the specified emulation.

Declaration

public static Stream Render(Stream inputStream, StarPrinterEmulation outputEmulation, ConversionOptions options)

Parameters

Type	Name	Description
System.IO.Stream	inputStream	Input data stream (Star Document Markup)
StarPrinterEmulation	outputEmulation	Printer emulation to be specified as the destination
ConversionOptions	options	Conversion options to specify conversion parameters and output results.

Returns

Type	Description
System.IO.Stream	The printer commands for the specified emulation.

RenderFile(string, StarPrinterEmulation, ConversionOptions)

Loads a Star Document Markup file and converts it into printer commands for the specified emulation.

Declaration

public static Stream RenderFile(string fileName, StarPrinterEmulation outputEmulation, ConversionOptions options)

Parameters

Type	Name	Description
System.String	fileName	Input file name (Star Document Markup)
StarPrinterEmulation	outputEmulation	Printer emulation to be specified as the destination
ConversionOptions	options	Conversion options to specify conversion parameters and output results.

Returns

Type	Description
System.IO.Stream	The printer commands for the specified emulation.

RenderWithApplyTemplate(Byte[], Byte[], StarPrinterEmulation, ConversionOptions)

Input template data (Star Document Markup) and field data (JSON) in a byte array buffer and converts it into printer commands for the specified emulation.

Declaration

public static Stream RenderWithApplyTemplate(byte[] templateBuffer, byte[] fieldBuffer, StarPrinterEmulation outputEmulation, ConversionOptions options)

Parameters

Type	Name	Description
System.Byte[]	templateBuffer	Input data buffer, Template data (Star Document Markup)
System.Byte[]	fieldBuffer	Input data buffer, Field data (JSON)
StarPrinterEmulation	outputEmulation	Printer emulation to be specified as the destination
ConversionOptions	options	Conversion options to specify conversion parameters and output results.

Returns

Type	Description
System.IO.Stream	The printer commands for the specified emulation.

RenderWithApplyTemplate(Stream, Stream, StarPrinterEmulation, ConversionOptions)

Input stream of template data (Star Document Markup) and field data (JSON) and converts it into printer commands for the specified emulation.

Declaration

public static Stream RenderWithApplyTemplate(Stream templateInputStream, Stream fieldInputStream, StarPrinterEmulation outputEmulation, ConversionOptions options)

Parameters

Type	Name	Description
System.IO.Stream	templateInputStream	Input data stream, Template data (Star Document Markup)
System.IO.Stream	fieldInputStream	Input data stream, Field data (JSON)
StarPrinterEmulation	outputEmulation	Printer emulation to be specified as the destination
ConversionOptions	options	Conversion options to specify conversion parameters and output results.

Returns

Type	Description
System.IO.Stream	The printer commands for the specified emulation.

RenderFileWithApplyTemplate(string, string, StarPrinterEmulation, ConversionOptions)

Input stream of template data (Star Document Markup) and field data (JSON) and converts it into printer commands for the specified emulation.

Declaration

public static Stream RenderFileWithApplyTemplate(string templateFileName, string fieldFileName, StarPrinterEmulation outputEmulation, ConversionOptions options)

Parameters

Type	Name	Description
System.String	templateFileName	Input file name, Template data (Star Document Markup)
System.String	fieldFileName	Input file name, Field data (JSON)
StarPrinterEmulation	outputEmulation	Printer emulation to be specified as the destination
ConversionOptions	options	Conversion options to specify conversion parameters and output results.

Returns

Type	Description
System.IO.Stream	The printer commands for the specified emulation.