Class LabelDocument

Represents a label document on the editor's surface.

Inheritance
System.Object
LabelDocument
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.Windows.ThermalLabelEditor
Assembly: cs.temp.dll.dll
Syntax
public class LabelDocument

Properties

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

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.

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

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 label document.

Declaration
public double Height { get; set; }
Property Value
Type Description
System.Double

IsContinuous

Gets or sets whether this document 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

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

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

NumOfFractionalDigits

Gets or sets the number of fractional digits to use with all floating-point values. Default is 4.

Declaration
public int NumOfFractionalDigits { get; set; }
Property Value
Type Description
System.Int32
Remarks

The number of fractional digits is used to round floating-point values like item's X and Y location, Width and Height, etc.

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; set; }
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

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 label document.

Declaration
public UnitType UnitType { get; set; }
Property Value
Type Description
UnitType

Width

Gets or sets the width of the label document.

Declaration
public double Width { get; set; }
Property Value
Type Description
System.Double

Methods

UpdateFrom(LabelDocument)

Updates this LabelDocument object with the properties of the specified LabelDocument object.

Declaration
public void UpdateFrom(LabelDocument doc)
Parameters
Type Name Description
LabelDocument doc

The LabelDocument object that is used for updating this LabelDocument object.