Class PrintJobLabelProgressEventArgs

Provides data for the LabelProgress event, raised right after each individual label of a data-bound print job (a job whose ThermalLabel has a DataSource, Counters and/or a Mask) has been rendered to image or has had its native printer commands generated - carrying just that one label's own output, so it can be sent to the printer / consumed right away, and/or the rest of the job canceled.

Inheritance

System.Object

System.EventArgs

PrintJobLabelProgressEventArgs

Inherited Members

System.EventArgs.Empty

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 PrintJobLabelProgressEventArgs : EventArgs

Properties

Cancel

Gets or sets whether to cancel the remaining labels of the job. Default is false. The label this event refers to has already been fully generated regardless of this flag. When set to true, no further labels are processed and a PrintJobCanceledException is thrown out of the PrintJob method that was called (e.g. GetNativePrinterCommands, GetBinaryNativePrinterCommands, ExportToImage, ExportToPdf, etc).

Declaration

public bool Cancel { get; set; }

Property Value

Type	Description
System.Boolean

LabelBinaryCommands

Gets the native printer commands (as binary), for just this label - not the whole job so far - so it can be sent straight to the printer. Populated only when this event was raised from GetNativePrinterCommands / GetBinaryNativePrinterCommands (the native printer commands pipeline); null when raised while rendering to image.

Declaration

public byte[] LabelBinaryCommands { get; }

Property Value

Type	Description
System.Byte[]

LabelCommands

Gets LabelBinaryCommands decoded as text (same codepage used by GetNativePrinterCommands). Null when LabelBinaryCommands is null.

Declaration

public string LabelCommands { get; }

Property Value

Type	Description
System.String

LabelImage

Gets the raster image bytes (PNG/JPEG/PCX/SVG, per ImageSettings.ImageFormat) rendered for just this label. Populated only when this event is raised from ExportToImage (or ExportToHtml, which renders to images internally) with a raster/SVG ImageSettings.ImageFormat; null for PDF exports (ExportToPdf), since individual labels aren't produced as separate encoded images there, and null when raised from the native-commands pipeline.

Declaration

public byte[] LabelImage { get; }

Property Value

Type	Description
System.Byte[]

LabelIndex

Gets the zero-based index of the label that was just processed.

Declaration

public int LabelIndex { get; }

Property Value

Type	Description
System.Int32

LabelNumber

Gets the one-based position of the label that was just processed (i.e. LabelIndex + 1).

Declaration

public int LabelNumber { get; }

Property Value

Type	Description
System.Int32

TotalLabels

Gets the total number of labels to be processed in this print job.

Declaration

public int TotalLabels { get; }

Property Value

Type	Description
System.Int32