Class WindowsPrintJob

Specifies information about how a thermal label is printed, including the printer device settings, label orientation, number of copies, etc.

Inheritance

System.Object

WindowsPrintJob

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

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

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

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Neodynamic.SDK.Printing

Assembly: cs.temp.dll.dll

Syntax

public class WindowsPrintJob : IDisposable

Constructors

WindowsPrintJob()

Initializes a new instance of the PrintJob class

Declaration

public WindowsPrintJob()

WindowsPrintJob(PrinterSettings)

Initializes a new instance of the PrintJob class with the specified printer settings.

Declaration

public WindowsPrintJob(PrinterSettings printerSettings)

Parameters

Type	Name	Description
PrinterSettings	printerSettings	The printer settings which provides info about the target printer.

Properties

BidiEncoding

The stirng encoding to be used in the BIDI communication. Default is UTF8.

Declaration

public Encoding BidiEncoding { get; set; }

Property Value

Type	Description
System.Text.Encoding

CommandsOptimizationEnabled

Gets or sets whether optimization mechanisms are performed when generating the printer commands. Default is true.

Declaration

public bool CommandsOptimizationEnabled { get; set; }

Property Value

Type	Description
System.Boolean

Copies

Gets or sets the number of copies of the thermal label to print. Default value is 1

Declaration

public int Copies { get; set; }

Property Value

Type	Description
System.Int32

DocumentName

Gets or sets the name of the document to print. Default is an empty string.

Declaration

public string DocumentName { get; set; }

Property Value

Type	Description
System.String

Duplex

Gets or sets the printer setting for double-sided printing. Default is false.

Declaration

public bool Duplex { get; set; }

Property Value

Type	Description
System.Boolean

FingerprintSettings

Gets the Fingerprint custom settings.

Declaration

public FingerprintSettings FingerprintSettings { get; }

Property Value

Type	Description
FingerprintSettings

MarginLeft

Gets or sets the left margin when printing a label as graphic. The unit of measure is the one specified in the ThermalLabel object. Default is -1 which means the label is printed horizontally centered.

Declaration

public double MarginLeft { get; set; }

Property Value

Type	Description
System.Double

MarginTop

Gets or sets the top margin when printing a label as graphic. The unit of measure is the one specified in the ThermalLabel object. Default is -1 which means the label is printed vertically centered.

Declaration

public double MarginTop { get; set; }

Property Value

Type	Description
System.Double

PrinterSettings

Gets or sets information about the thermal printer used for printing.

Declaration

public PrinterSettings PrinterSettings { get; set; }

Property Value

Type	Description
PrinterSettings

PrintOrientation

Gets or sets the page orientation used to print the thermal label. Default value is Portrait

Declaration

public PrintOrientation PrintOrientation { get; set; }

Property Value

Type	Description
PrintOrientation

Replicates

Gets or sets the number of replicates of the thermal label to print. Default value is 0 (zero)

Declaration

public int Replicates { get; set; }

Property Value

Type	Description
System.Int32

ThermalLabel

Gets or sets the ThermalLabel object to be printed out. Default value is Null

Declaration

public ThermalLabel ThermalLabel { get; set; }

Property Value

Type	Description
ThermalLabel

Methods

CloseBidiComm()

Closes a BIDI communication.

Declaration

public void CloseBidiComm()

Dispose()

Declaration

public void Dispose()

Implements

System.IDisposable.Dispose()

OnDataRead(BidiCommEventArgs)

Declaration

protected void OnDataRead(BidiCommEventArgs e)

Parameters

Type	Name	Description
BidiCommEventArgs	e

OnError(BidiCommErrorEventArgs)

Declaration

protected void OnError(BidiCommErrorEventArgs e)

Parameters

Type	Name	Description
BidiCommErrorEventArgs	e

OpenBidiComm()

Opens a BIDI communication based on the PrinterSettings property.

Declaration

public void OpenBidiComm()

Print()

Starts the thermal label's printing process. Raw Commands will be sent to the specified printer.

Declaration

public void Print()

Print(List<ThermalLabel>)

Starts the printing process of the specified group of ThermalLabel objects. Raw Commands will be sent to the specified printer.

Declaration

public void Print(List<ThermalLabel> thermalLabelGroup)

Parameters

Type	Name	Description
System.Collections.Generic.List<ThermalLabel>	thermalLabelGroup	The group of ThermalLabel objects to print out.

Print(ThermalLabel)

Starts the printing process of the specified ThermalLabel object. Raw Commands will be sent to the specified printer.

Declaration

public void Print(ThermalLabel thermalLabel)

Parameters

Type	Name	Description
ThermalLabel	thermalLabel	The ThermalLabel object to print out.

PrintAsGraphic()

Starts the thermal label's printing process. Graphic Commands will be sent to the specified printer.

Declaration

public void PrintAsGraphic()

PrintAsGraphic(List<ThermalLabel>)

Starts the printing process of the specified group of ThermalLabel objects. Graphic Commands will be sent to the specified printer.

Declaration

public void PrintAsGraphic(List<ThermalLabel> thermalLabelGroup)

Parameters

Type	Name	Description
System.Collections.Generic.List<ThermalLabel>	thermalLabelGroup	The group of ThermalLabel objects to print out.

PrintAsGraphic(List<ThermalLabel>, Double)

Starts the printing process of the specified group of ThermalLabel with the specified scale settings. Graphic Commands will be sent to the specified printer.

Declaration

public void PrintAsGraphic(List<ThermalLabel> thermalLabelGroup, double scale)

Parameters

Type	Name	Description
System.Collections.Generic.List<ThermalLabel>	thermalLabelGroup	The group of ThermalLabel objects to print out.
System.Double	scale	The scaling factor.

PrintAsGraphic(List<ThermalLabel>, Double, Double)

Starts the printing process of the specified group of ThermalLabel with the specified scale settings. Graphic Commands will be sent to the specified printer.

Declaration

public void PrintAsGraphic(List<ThermalLabel> thermalLabelGroup, double scaleX, double scaleY)

Parameters

Type	Name	Description
System.Collections.Generic.List<ThermalLabel>	thermalLabelGroup	The group of ThermalLabel objects to print out.
System.Double	scaleX	The scaling factor in the X direction.
System.Double	scaleY	The scaling factor in the Y direction.

PrintAsGraphic(ThermalLabel)

Starts the printing process of the specified ThermalLabel object. Graphic Commands will be sent to the specified printer.

Declaration

public void PrintAsGraphic(ThermalLabel thermalLabel)

Parameters

Type	Name	Description
ThermalLabel	thermalLabel	The ThermalLabel object to print out.

PrintAsGraphic(ThermalLabel, Double)

Starts the printing process of the specified ThermalLabel object with the specified scale settings. Graphic Commands will be sent to the specified printer.

Declaration

public void PrintAsGraphic(ThermalLabel thermalLabel, double scale)

Parameters

Type	Name	Description
ThermalLabel	thermalLabel	The ThermalLabel object to print out.
System.Double	scale	The scaling factor.

PrintAsGraphic(ThermalLabel, Double, Double)

Starts the printing process of the specified ThermalLabel object with the specified scale settings. Graphic Commands will be sent to the specified printer.

Declaration

public void PrintAsGraphic(ThermalLabel thermalLabel, double scaleX, double scaleY)

Parameters

Type	Name	Description
ThermalLabel	thermalLabel	The ThermalLabel object to print out.
System.Double	scaleX	The scaling factor in the X direction.
System.Double	scaleY	The scaling factor in the Y direction.

PrintAsGraphic(ThermalLabel, Tuple<Double, Double>)

Starts the printing process of the specified ThermalLabel object targeting a new size. Graphic Commands will be sent to the specified printer.

Declaration

public void PrintAsGraphic(ThermalLabel thermalLabel, Tuple<double, double> targetLabelSize)

Parameters

Type	Name	Description
ThermalLabel	thermalLabel	The ThermalLabel object to print out.
System.Tuple<System.Double, System.Double>	targetLabelSize	The target label size. The unit is the specified by the ThermalLabel object.

PrintFiles(Byte[])

Starts the printing process of the specified files.

Declaration

public void PrintFiles(byte[] printFilesBinaryContent)

Parameters

Type	Name	Description
System.Byte[]	printFilesBinaryContent	The binary content of the print files.

Write(String)

Writes (sends) data to the target device in the BIDI communication.

Declaration

public void Write(string data)

Parameters

Type	Name	Description
System.String	data	The data to be written (sent) to the target device.

Events

DataRead

Occurs when data is received from the target device in the BIDI communication.

Declaration

public event DataReadEventHandler DataRead

Event Type

Type	Description
DataReadEventHandler

Error

Occurs when an error happens in the BIDI communication.

Declaration

public event ErrorEventHandler Error

Event Type

Type	Description
ErrorEventHandler