Class ThermalLabel

Represents a thermal label object.

Inheritance

System.Object

ThermalLabel

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 ThermalLabel

Constructors

ThermalLabel()

Initializes a new instance of the ThermalLabel class.

Declaration

public ThermalLabel()

ThermalLabel(UnitType, Double, Double)

Initializes a new instance of the ThermalLabel class with the specified Unit of Measurement and size.

Declaration

public ThermalLabel(UnitType unit, double width, double height)

Parameters

Type	Name	Description
UnitType	unit	The Unit of Measurement for the thermal label.
System.Double	width	The width of the thermal label.
System.Double	height	The height of the thermal label.

Properties

BatchCut

Gets or sets number of labels after which the cut will be performed. Default is 1.

Declaration

public int BatchCut { get; set; }

Property Value

Type	Description
System.Int32

Remarks

The printer must have with a cutter for this command to work and CutAfterPrinting property must be set to true.

CutAfterPrinting

Gets or sets whether this label is cut after printing. Default is false.

Declaration

public bool CutAfterPrinting { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

The printer must have with a cutter for this command to work.

Darkness

Gets or sets the output printing darkness setting which depends on the target printer type. Read remarks.

Declaration

public double Darkness { get; set; }

Property Value

Type	Description
System.Double

Remarks

- For ZPL printers: The darkness level which must range from -30 to 30, depending on current value of printer settings. NOTE: The darkness level for the XiIIIPlus printer must be 0 to 30 in increments of 0.1.

- For EPL printers: The darkness level must range from 0 to 15.

- For Intermect/Fingerprint printers: The darkness level must range from -10 to 10 in steps of 2.

DataMember

Gets or sets the name of the list or table in the data source. Default is an empty string

Declaration

public string DataMember { get; set; }

Property Value

Type	Description
System.String

DataSource

Gets or sets the data source for this thermal label. Default value is Null

Declaration

public object DataSource { get; set; }

Property Value

Type	Description
System.Object

Remarks

The data source type supported are System.Data.DataSet, System.Data.DataTable, System.Data.DataView, System.Data.IDataReader, System.Collections.IEnumerable and path files for XML and CSV formats.

DataSourceCultureInfo

Gets or sets the culture information used for formatting data source fields when binding to label items. Default is InvariantCulture

Declaration

public CultureInfo DataSourceCultureInfo { get; set; }

Property Value

Type	Description
CultureInfo

DesignBackgroundImage

A non-printing background image (in PNG format) that assists you in the design of your labels through the visual editors. Image must be specified in Base64 format.

Declaration

public string DesignBackgroundImage { get; set; }

Property Value

Type	Description
System.String

Expressions

Gets a collection of string objects representing the set of Expressions to be applied on the this thermal label object at rendering time. Mainly used to manipulate Items properties before generating the label output. Default value is an empty collection

Declaration

public Collection<string> Expressions { get; }

Property Value

Type	Description
Collection<System.String>

Fonts

Gets a collection of ThermalLabelFont objects representing the embedded fonts within this thermal label object. Default value is an empty collection.

Declaration

public Collection<ThermalLabelFont> Fonts { get; }

Property Value

Type	Description
Collection<ThermalLabelFont>

GapLength

Gets or sets the vertical gap length between labels. The unit of measurement is specified by UnitType property. Default value is 0 (zero)

Declaration

public double GapLength { get; set; }

Property Value

Type	Description
System.Double

Height

Gets or sets the height of the thermal label. The unit of measurement is specified by UnitType property. Default value is 1

Declaration

public double Height { get; set; }

Property Value

Type	Description
System.Double

IsContinuous

Gets or sets whether this ThermalLabel is on a continuous media roll i.e. labels are not separated by gaps, spaces, notches, slots, or holes. Default is false.

Declaration

public bool IsContinuous { get; set; }

Property Value

Type	Description
System.Boolean

IsDataBound

Gets whether any Item in the current label is data bound.

Declaration

public bool IsDataBound { get; }

Property Value

Type	Description
System.Boolean

IsSheetOfLabels

Gets whether this label is a Sheet of labels type.

Declaration

public bool IsSheetOfLabels { get; }

Property Value

Type	Description
System.Boolean

Items

Gets a collection of Item objects representing the individual items within the thermal label. Default value is an empty collection

Declaration

public ItemCollection Items { get; }

Property Value

Type	Description
ItemCollection

LabelsHorizontalGapLength

Gets or sets the horizontal gap length between labels when the media roll contains more than one label per row. The unit of measurement is specified by UnitType property. Default value is 0 (zero)

Declaration

public double LabelsHorizontalGapLength { get; set; }

Property Value

Type	Description
System.Double

LabelsPerRow

Gets or sets the number of labels per row in the media roll. Default value is 1

Declaration

public int LabelsPerRow { get; set; }

Property Value

Type	Description
System.Int32

LicenseKey

Gets or sets the license key info.

Declaration

public static string LicenseKey { get; set; }

Property Value

Type	Description
System.String

LicenseOwner

Gets or sets the license owner info.

Declaration

public static string LicenseOwner { get; set; }

Property Value

Type	Description
System.String

Margin

Gets or sets the margin of the thermal label. The unit of measurement is specified by UnitType property. Default value is 0.

Declaration

public FrameThickness Margin { get; set; }

Property Value

Type	Description
FrameThickness

MarkLength

Gets or sets the mark length or thickness between labels. The unit of measurement is specified by UnitType property. Default value is 0 (zero)

Declaration

public double MarkLength { get; set; }

Property Value

Type	Description
System.Double

OffsetLength

Gets or sets the offset length or thickness between labels. The unit of measurement is specified by UnitType property. Default value is 0 (zero)

Declaration

public double OffsetLength { get; set; }

Property Value

Type	Description
System.Double

Pages

Gets a collection of ThermalLabelPage objects representing the pages within this thermal label object. Default value is an empty collection.

Declaration

public Collection<ThermalLabelPage> Pages { get; }

Property Value

Type	Description
Collection<ThermalLabelPage>

PrintMirror

Gets or sets whether this label is printed as a mirror image. Default is false.

Declaration

public bool PrintMirror { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

This command is not supported by Zebra EPL printers. In this case, it will be ignored.

PrintSpeed

Gets or sets the media speed during printing. The value setting depends on the printer model and usually is in IPS (Inch Per Seconds). Look for it in the printer user manual.

Declaration

public string PrintSpeed { get; set; }

Property Value

Type	Description
System.String

SheetLabelsCount

Gets or sets the total number individual labels of the Sheet Labels where this thermal label is part of. Default value is 0.

Declaration

public int SheetLabelsCount { get; set; }

Property Value

Type	Description
System.Int32

SheetLabelsHeight

Gets or sets the height of the Sheet Labels where this thermal label is part of. The unit of measurement is specified by UnitType property. Default value is 0.

Declaration

public double SheetLabelsHeight { get; set; }

Property Value

Type	Description
System.Double

SheetLabelsMargin

Gets or sets the margin of the Sheet Labels where this thermal label is part of. The unit of measurement is specified by UnitType property. Default value is 0.

Declaration

public FrameThickness SheetLabelsMargin { get; set; }

Property Value

Type	Description
FrameThickness

SheetLabelsWidth

Gets or sets the width of the Sheet Labels where this thermal label is part of. The unit of measurement is specified by UnitType property. Default value is 0.

Declaration

public double SheetLabelsWidth { get; set; }

Property Value

Type	Description
System.Double

UnitType

Gets or sets the Unit of Measurement for the thermal label. The Unit of Measurement affects the thermal label size as well as its items' dimensions and locations. Default value is Inch

Declaration

public UnitType UnitType { get; set; }

Property Value

Type	Description
UnitType

UseDefaultMediaType

Gets or sets whether to use the default printer configuration for Media Type (Continuous, Web sensing, Mark sensing, etc). Default is false.

Declaration

public bool UseDefaultMediaType { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

For ZPL printers only.

Width

Gets or sets the width of the thermal label. The unit of measurement is specified by UnitType property. Default value is 1

Declaration

public double Width { get; set; }

Property Value

Type	Description
System.Double

Methods

Clone()

Creates a copy of the current ThermalLabel.

Declaration

public ThermalLabel Clone()

Returns

Type	Description
ThermalLabel	A copy of the current ThermalLabel.

CreateFromJsonTemplate(String)

Creates a ThermalLabel object based on the content of the specified JSON Template.

Declaration

public static ThermalLabel CreateFromJsonTemplate(string jsonTemplate)

Parameters

Type	Name	Description
System.String	jsonTemplate	The content of the JSON Template.

Returns

Type	Description
ThermalLabel	A ThermalLabel object based on the content of the specified JSON Template.

CreateFromXmlTemplate(String)

Creates a ThermalLabel object based on the content of the specified XML Template.

Declaration

public static ThermalLabel CreateFromXmlTemplate(string xmlTemplate)

Parameters

Type	Name	Description
System.String	xmlTemplate	The content of the XML Template.

Returns

Type	Description
ThermalLabel	A ThermalLabel object based on the content of the specified XML Template.

GetJsonTemplate(Boolean)

Gets a JSON representing this ThermalLabel object.

Declaration

public string GetJsonTemplate(bool embedFonts = false)

Parameters

Type	Name	Description
System.Boolean	embedFonts	Whether to embed fonts in the template.

Returns

Type	Description
System.String	A JSON representing this ThermalLabel object.

GetXmlTemplate(Boolean)

Gets an XML Template for this ThermalLabel object.

Declaration

public string GetXmlTemplate(bool embedFonts = false)

Parameters

Type	Name	Description
System.Boolean	embedFonts

Returns

Type	Description
System.String	An XML Template for this ThermalLabel object.

LoadJsonTemplate(String)

Restores this ThermalLabel object based on the content of the specified JSON Template.

Declaration

public void LoadJsonTemplate(string jsonTemplate)

Parameters

Type	Name	Description
System.String	jsonTemplate	A JSON Template for restoring this ThermalLabel object.

LoadXmlTemplate(String)

Restores this ThermalLabel object based on the content of the specified XML Template.

Declaration

public void LoadXmlTemplate(string xmlTemplate)

Parameters

Type	Name	Description
System.String	xmlTemplate	An XML Template for restoring this ThermalLabel object.