Class ConversionOptions

Provide a set of parameters to be used by an ICpDocument class when converting a print job between formats and preparing it for printing.

Inheritance

System.Object

ConversionOptions

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 class ConversionOptions

Remarks

Not all options are, or can be supported by all document convertion methods. For example, PNG and Jpeg files can not contain device commands to open a cash drawer, sound buzzer or specify the cut method. In these cases, please use printer native command target types where possible, or refer to the cloudprnt specification for for alternative methods of requesting device specific functions via http headers.

Fields

HorizontalResolution

Horizontal device resolution, specified in dots per mm. This information should be received by a server by performing the PageInfo clientAction request, and then cached for each device. Defaults to 8, the standard for Str thermal printers. This property is a float to allow for resolutions that do not fit mm boundries exactly, which is typical for a Star dot-matrix model.

Declaration

public float HorizontalResolution

Field Value

Type	Description
System.Single

VerticalResolution

Vertical device resolution, specified in dots per mm. This information should be received by a server by performing the PageInfo clientAction request, and then cached for each device. Defaults to 8, the standard for Str thermal printers. This property is a float to allow for resolutions that do not fit mm boundries exactly, which is typical for a Star dot-matrix model.

Declaration

public float VerticalResolution

Field Value

Type	Description
System.Single

Properties

BuzzerEndPattern

Request an audio buzzer sequence to be fired at the end of printing the job. Defaults to 0, meaning no sound. Note that this requires a buzzer unit to be connected to the printer peripheral port in most cases. This Option applies to MarkupDoc, ImageDoc, and TextDoc documents when they are converted to a printer native command format.

Declaration

public int BuzzerEndPattern { get; set; }

Property Value

Type	Description
System.Int32

BuzzerStartPattern

Request an audio buzzer sequence to be fired at the start of printing the job. Defaults to 0, meaning no sound. Note that this requires a buzzer unit to be connected to the printer peripheral port in most cases. This Option applies to MarkupDoc, ImageDoc, and TextDoc documents when they are converted to a printer native command format.

Declaration

public int BuzzerStartPattern { get; set; }

Property Value

Type	Description
System.Int32

DefaultFont

Specify the default device font to be used when printing. This setting is primarily used only by the TextDoc when converting a text document to native printer commands.

Declaration

public DeviceFont DefaultFont { get; set; }

Property Value

Type	Description
DeviceFont

DeviceWidth

Specify the output print width as total number of horizontal dots per line. This information should be received by a server by performing the PageInfo clientAction request, and then cached for each device. By default, this will be set to 576dots, the most common standard to a Star 80mm thermal printer.

Declaration

public int DeviceWidth { get; set; }

Property Value

Type	Description
System.Int32

HoldPrintControlType

Request a setting of hold print control. Defaults to undefined, meaning no specify. And it recommends to set invalid if use this option. Note that this requires TSP650II SK model at this time and the other models are not supported. This Option applies to MarkupDoc, ImageDoc, and TextDoc documents when they are converted to a printer native command format.

Declaration

public HoldPrintControl HoldPrintControlType { get; set; }

Property Value

Type	Description
HoldPrintControl

JobEndCutType

Specify the type of cut to perform at the end of a print job. This option applies only to ImageDoc, and TextDoc document types, when outputting to a native printer commands.

Declaration

public CutType JobEndCutType { get; set; }

Property Value

Type	Description
CutType

JobEndFeedToCutter

Specify whether the document should feed the paper from print head before cutting. This option applies only to ImageDoc, and TextDoc document types, when outputting to a native printer commands.

Declaration

public bool JobEndFeedToCutter { get; set; }

Property Value

Type	Description
System.Boolean

OpenCashDrawer

Request that a cash drawer is opened while printing this job. This Option applies to MarkupDoc, ImageDoc, and TextDoc documents when they are converted to a printer native command format.

Declaration

public DrawerOpenTime OpenCashDrawer { get; set; }

Property Value

Type	Description
DrawerOpenTime

PaperPresentStatusControlType

Request a setting for inform of paper present status at paper exit. Defaults to undefined, meaning no specify. And it recommends to set default or valid if use this option. Note that this requires TSP650II SK model at this time and the other models are not supported. This Option applies to MarkupDoc, ImageDoc, and TextDoc documents when they are converted to a printer native command format.

Declaration

public PaperPresentStatusControl PaperPresentStatusControlType { get; set; }

Property Value

Type	Description
PaperPresentStatusControl

PerformDither

If true then images on the document will be dithered by default before prnting, to improve the appearance of colour and grey parts of images.

Declaration

public bool PerformDither { get; set; }

Property Value

Type	Description
System.Boolean

ScaleToFit

Request that the source document is resized automatically to fit the output device when set to true. If set to false, then the source image may not fill the output page, or may be cropped if too large to fit. This setting applies mainly to the ImageDoc document class, but is also useb by the MarkupDoc class when large images are included withing the document and a sise has not been specified by the markup.

Declaration

public bool ScaleToFit { get; set; }

Property Value

Type	Description
System.Boolean

SupportUTF8

Set this to true if it is known that the target client device can natively support UTF8 encoding. If so, then this will be used by the TextDoc and MarkupDoc to allow a wider range of character printing.

Declaration

public bool SupportUTF8 { get; set; }

Property Value

Type	Description
System.Boolean