Class ThermalLabelEditor

ThermalLabelEditor lets end-users to graphically design barcode thermal labels inside your WPF Windows applications.

Inheritance

System.Object

ThermalLabelEditor

Namespace: Neodynamic.Windows.WPF.ThermalLabelEditor

Assembly: cs.temp.dll.dll

Syntax

public class ThermalLabelEditor : Grid

Constructors

ThermalLabelEditor()

Declaration

public ThermalLabelEditor()

Fields

ActiveToolItemProperty

Declaration

public static DependencyProperty ActiveToolItemProperty

Field Value

Type	Description
DependencyProperty

ActiveToolProperty

Declaration

public static DependencyProperty ActiveToolProperty

Field Value

Type	Description
DependencyProperty

AdornerFrameBorderColorProperty

Declaration

public static DependencyProperty AdornerFrameBorderColorProperty

Field Value

Type	Description
DependencyProperty

AdornerHandlerBackColorProperty

Declaration

public static DependencyProperty AdornerHandlerBackColorProperty

Field Value

Type	Description
DependencyProperty

AdornerHandlerBorderColorProperty

Declaration

public static DependencyProperty AdornerHandlerBorderColorProperty

Field Value

Type	Description
DependencyProperty

AdornerHandlerHoverBackColorProperty

Declaration

public static DependencyProperty AdornerHandlerHoverBackColorProperty

Field Value

Type	Description
DependencyProperty

AdornerLegendsVisibleProperty

Declaration

public static DependencyProperty AdornerLegendsVisibleProperty

Field Value

Type	Description
DependencyProperty

AdornerSelectionBackColorProperty

Declaration

public static DependencyProperty AdornerSelectionBackColorProperty

Field Value

Type	Description
DependencyProperty

AdornerSelectionBorderColorProperty

Declaration

public static DependencyProperty AdornerSelectionBorderColorProperty

Field Value

Type	Description
DependencyProperty

AngleSnapProperty

Declaration

public static DependencyProperty AngleSnapProperty

Field Value

Type	Description
DependencyProperty

ArrowKeysLargeStepProperty

Declaration

public static DependencyProperty ArrowKeysLargeStepProperty

Field Value

Type	Description
DependencyProperty

ArrowKeysShortStepProperty

Declaration

public static DependencyProperty ArrowKeysShortStepProperty

Field Value

Type	Description
DependencyProperty

CanCopyProperty

Declaration

public static readonly DependencyProperty CanCopyProperty

Field Value

Type	Description
DependencyProperty

CanCutProperty

Declaration

public static readonly DependencyProperty CanCutProperty

Field Value

Type	Description
DependencyProperty

CanPasteProperty

Declaration

public static readonly DependencyProperty CanPasteProperty

Field Value

Type	Description
DependencyProperty

CanRedoProperty

Declaration

public static readonly DependencyProperty CanRedoProperty

Field Value

Type	Description
DependencyProperty

CanUndoProperty

Declaration

public static readonly DependencyProperty CanUndoProperty

Field Value

Type	Description
DependencyProperty

CurrentSelectionAreaProperty

Declaration

public static readonly DependencyProperty CurrentSelectionAreaProperty

Field Value

Type	Description
DependencyProperty

CurrentSelectionProperty

Declaration

public static readonly DependencyProperty CurrentSelectionProperty

Field Value

Type	Description
DependencyProperty

GridSizeProperty

Declaration

public static DependencyProperty GridSizeProperty

Field Value

Type	Description
DependencyProperty

ImageProcessingDpiProperty

Declaration

public static DependencyProperty ImageProcessingDpiProperty

Field Value

Type	Description
DependencyProperty

LabelDocumentFrameBackgroundProperty

Declaration

public static DependencyProperty LabelDocumentFrameBackgroundProperty

Field Value

Type	Description
DependencyProperty

LabelDocumentFrameBorderColorProperty

Declaration

public static DependencyProperty LabelDocumentFrameBorderColorProperty

Field Value

Type	Description
DependencyProperty

LabelDocumentFrameBorderThicknessProperty

Declaration

public static DependencyProperty LabelDocumentFrameBorderThicknessProperty

Field Value

Type	Description
DependencyProperty

LabelDocumentFrameCornerRadiusProperty

Declaration

public static DependencyProperty LabelDocumentFrameCornerRadiusProperty

Field Value

Type	Description
DependencyProperty

LabelDocumentProperty

Declaration

public static readonly DependencyProperty LabelDocumentProperty

Field Value

Type	Description
DependencyProperty

NoImageFileNameProperty

Declaration

public static DependencyProperty NoImageFileNameProperty

Field Value

Type	Description
DependencyProperty

RFIDTagImageFileNameProperty

Declaration

public static DependencyProperty RFIDTagImageFileNameProperty

Field Value

Type	Description
DependencyProperty

RulerBackgroundProperty

Declaration

public static DependencyProperty RulerBackgroundProperty

Field Value

Type	Description
DependencyProperty

RulerForeColorProperty

Declaration

public static DependencyProperty RulerForeColorProperty

Field Value

Type	Description
DependencyProperty

RulerLinesColorProperty

Declaration

public static DependencyProperty RulerLinesColorProperty

Field Value

Type	Description
DependencyProperty

RulerSelectionColorProperty

Declaration

public static DependencyProperty RulerSelectionColorProperty

Field Value

Type	Description
DependencyProperty

ShowGridProperty

Declaration

public static DependencyProperty ShowGridProperty

Field Value

Type	Description
DependencyProperty

SnapToGridProperty

Declaration

public static DependencyProperty SnapToGridProperty

Field Value

Type	Description
DependencyProperty

TextItemEditModeEnabledProperty

Declaration

public static DependencyProperty TextItemEditModeEnabledProperty

Field Value

Type	Description
DependencyProperty

ZoomProperty

Declaration

public static DependencyProperty ZoomProperty

Field Value

Type	Description
DependencyProperty

Properties

ActiveTool

Gets or sets the current active tool of the editor. Default is the Pointer tool used for selection action mainly.

Declaration

public EditorTool ActiveTool { get; set; }

Property Value

Type	Description
EditorTool

ActiveToolItem

Gets or sets the Item object which is added to the editor's surface by the end-user.

Declaration

public Item ActiveToolItem { get; set; }

Property Value

Type	Description
Item

Remarks

The Item object specified by this property must match the type which is currently set up to the ActiveTool property. For example, if the ActiveTool is set up to Text, then a new TextItem object needs to be specified to the ActiveToolItem property.

AdornerFrameBorderColor

Gets or sets the border color for the adorner's frame. Default is Black.

Declaration

public Windows.Media.Color AdornerFrameBorderColor { get; set; }

Property Value

Type	Description
System.Windows.Media.Color

AdornerHandlerBackColor

Gets or sets the background color for the adorner's handlers. Default is Green.

Declaration

public Windows.Media.Color AdornerHandlerBackColor { get; set; }

Property Value

Type	Description
System.Windows.Media.Color

AdornerHandlerBorderColor

Gets or sets the border color for the adorner's handlers. Default is Black.

Declaration

public Windows.Media.Color AdornerHandlerBorderColor { get; set; }

Property Value

Type	Description
System.Windows.Media.Color

AdornerHandlerHoverBackColor

Gets or sets the background color for the adorner's handlers when the mouse pointer is over them. Default is Red.

Declaration

public Windows.Media.Color AdornerHandlerHoverBackColor { get; set; }

Property Value

Type	Description
System.Windows.Media.Color

AdornerLegendsVisible

Gets or sets whether the text legends of adorners are visible or not. Default is true.

Declaration

public bool AdornerLegendsVisible { get; set; }

Property Value

Type	Description
System.Boolean

AdornerSelectionBackColor

Gets or sets the background color for the selection adorner's frame.

Declaration

public Windows.Media.Color AdornerSelectionBackColor { get; set; }

Property Value

Type	Description
System.Windows.Media.Color

AdornerSelectionBorderColor

Gets or sets the border color for the selection adorner's frame.

Declaration

public Windows.Media.Color AdornerSelectionBorderColor { get; set; }

Property Value

Type	Description
System.Windows.Media.Color

AngleSnap

Gets or sets the angle snap used for items' rotation. Default is 5 degrees.

Declaration

public int AngleSnap { get; set; }

Property Value

Type	Description
System.Int32

ArrowKeysLargeStep

Gets or sets the large step size in current unit when any of the arrow keys and the control key are pressed. Default is 0.1 inch.

Declaration

public double ArrowKeysLargeStep { get; set; }

Property Value

Type	Description
System.Double

ArrowKeysShortStep

Gets or sets the short step size in current unit when any of the arrow keys are pressed. Default is 0.01 inch.

Declaration

public double ArrowKeysShortStep { get; set; }

Property Value

Type	Description
System.Double

CanCopy

Gets whether a Clipboard Copy action can be performed.

Declaration

public bool CanCopy { get; }

Property Value

Type	Description
System.Boolean

CanCut

Gets whether a Clipboard Cut action can be performed.

Declaration

public bool CanCut { get; }

Property Value

Type	Description
System.Boolean

CanPaste

Gets whether a Clipboard Paste action can be performed.

Declaration

public bool CanPaste { get; }

Property Value

Type	Description
System.Boolean

CanRedo

Gets whether the Redo action is available.

Declaration

public bool CanRedo { get; }

Property Value

Type	Description
System.Boolean

CanUndo

Gets whether the Undo action is available.

Declaration

public bool CanUndo { get; }

Property Value

Type	Description
System.Boolean

CurrentSelection

Gets the current selected item on the editor.

Declaration

public Item CurrentSelection { get; }

Property Value

Type	Description
Item

Remarks

This property returns an Item-derived class representing the current selection on the editor.

If the selection is just one item only, then the returned object will be the Item-derived class of such object. For exmaple, if a Rectangle item is selected, then the returned object will be a RectangleShapeItem instance.

If the selection contains more than one item, then the returned object will be an instance of the MultipleSelectionItem class. The MultipleSelectionItem class contains some properties that are common to most Item-derived classes. That means that some properties of such class are common to all Item-derived classes, for example, the X and Y properties. Notice that the MultipleSelectionItem class also contains some properties that are common for a group of Item-derived classes and not to all. For example, the Font property is valid for TextItem and BarcodeItem object only.

CurrentSelectionArea

Gets the location and size of the current selected items on the editor.

Declaration

public Rect CurrentSelectionArea { get; }

Property Value

Type	Description
Rect

GridSize

Gets or sets the size of the grid in current unit. Default is zero.

Declaration

public double GridSize { get; set; }

Property Value

Type	Description
System.Double

ImageProcessingDpi

Gets or sets the DPI value which will be used for processing the ImageItem objects on the editor's surface. Default is 96 dpi.

Declaration

public double ImageProcessingDpi { get; set; }

Property Value

Type	Description
System.Double

LabelDocument

Gets the LabelDocument object that represents a ThermalLabel object on the editor's surface.

Declaration

public LabelDocument LabelDocument { get; }

Property Value

Type	Description
LabelDocument

Remarks

The LabelDocument object is a lightweight version of the ThermalLabel class and is automatically created when you load a ThermalLabel object through the LoadThermalLabel() method.

LabelDocumentFrameBackground

Gets or sets the background brush for the label document frame on the editor's surface. Default is White.

Declaration

public Brush LabelDocumentFrameBackground { get; set; }

Property Value

Type	Description
Brush

LabelDocumentFrameBorderColor

Gets or sets the border color for the label document frame on the editor's surface. Default is White.

Declaration

public Windows.Media.Color LabelDocumentFrameBorderColor { get; set; }

Property Value

Type	Description
System.Windows.Media.Color

LabelDocumentFrameBorderThickness

Gets or sets the thickness of the label document frame's border on the editor's surface. Default is 0.5.

Declaration

public double LabelDocumentFrameBorderThickness { get; set; }

Property Value

Type	Description
System.Double

LabelDocumentFrameCornerRadius

Gets or sets the radii of the corners of the label document frame. Default value is 10.

Declaration

public double LabelDocumentFrameCornerRadius { get; set; }

Property Value

Type	Description
System.Double

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

NoImageFileName

Gets or sets the image file name to display on the editor's surface when the source of an ImageItem cannot be found.

Declaration

public string NoImageFileName { get; set; }

Property Value

Type	Description
System.String

RFIDTagImageFileName

Gets or sets the image file name to display on the editor's surface for a RFIDTagItem.

Declaration

public string RFIDTagImageFileName { get; set; }

Property Value

Type	Description
System.String

RulerBackground

Gets or sets the background brush for the editor's rulers. Default is SystemColors.ControlBrush

Declaration

public Brush RulerBackground { get; set; }

Property Value

Type	Description
Brush

RulerForeColor

Gets or sets the foreground color for the number tags of the editor's rulers.

Declaration

public Windows.Media.Color RulerForeColor { get; set; }

Property Value

Type	Description
System.Windows.Media.Color

RulerLinesColor

Gets or sets the color for the lines which compose the editor's rulers.

Declaration

public Windows.Media.Color RulerLinesColor { get; set; }

Property Value

Type	Description
System.Windows.Media.Color

RulerSelectionColor

Gets or sets the background color for the selection zone of the editor's rulers.

Declaration

public Windows.Media.Color RulerSelectionColor { get; set; }

Property Value

Type	Description
System.Windows.Media.Color

ShowGrid

Gets or sets whether grid is displayed. Default is false.

Declaration

public bool ShowGrid { get; set; }

Property Value

Type	Description
System.Boolean

SnapToGrid

Gets or sets whether items will be placed and sized according to the divisions of the grid. Default is false.

Declaration

public bool SnapToGrid { get; set; }

Property Value

Type	Description
System.Boolean

TextItemEditModeEnabled

Gets or sets whether TextItem objects can enter in Edit Mode. Default is true.

Declaration

public bool TextItemEditModeEnabled { get; set; }

Property Value

Type	Description
System.Boolean

Zoom

Gets or sets the zoom percentage level of the editor's content. The valid range for zoom is 10% - 1000%. Default is 100 which means normal size.

Declaration

public double Zoom { get; set; }

Property Value

Type	Description
System.Double

Methods

AddItem(Item)

Adds an Item to the end of the items collection of the current label.

Declaration

public void AddItem(Item item)

Parameters

Type	Name	Description
Item	item	The item to add.

BringForward()

Brings the selected items one step closer to the front of the label surface.

Declaration

public void BringForward()

BringToFront()

Brings the selected items to the front of the label surface.

Declaration

public void BringToFront()

Close()

Closes the current label document.

Declaration

public void Close()

Copy()

Copies the current selection in the editor to the internal Clipboard.

Declaration

public void Copy()

CreateThermalLabel()

Creates a ThermalLabel object based on the current LabelDocument data and visual items.

Declaration

public ThermalLabel CreateThermalLabel()

Returns

Type	Description
ThermalLabel	A ThermalLabel object.

Cut()

Cuts the current selection in the editor and moves it to the internal Clipboard.

Declaration

public void Cut()

DeleteAll()

Deletes all the items on the editor's surface.

Declaration

public void DeleteAll()

DeleteSelectedItems()

Deletes the selected items on the editor's surface.

Declaration

public void DeleteSelectedItems()

InsertItem(Int32, Item)

Inserts an Item into the current label at the specified index.

Declaration

public void InsertItem(int index, Item item)

Parameters

Type	Name	Description
System.Int32	index	The zero-based index at which the item should be inserted.
Item	item	The item to insert.

LoadThermalLabel(ThermalLabel)

Loads the specified ThermalLabel object on the editor's surface.

Declaration

public void LoadThermalLabel(ThermalLabel thermalLabel)

Parameters

Type	Name	Description
ThermalLabel	thermalLabel	A ThermalLabel object.

LockSelectedItems()

Locks all the items in the current selection.

Declaration

public void LockSelectedItems()

MoveSelectedItems(Double, Double)

Moves the selected items by the specified horizontal and vertical offsets.

Declaration

public void MoveSelectedItems(double deltaX, double deltaY)

Parameters

Type	Name	Description
System.Double	deltaX	The horizontal (X-axis) offset.
System.Double	deltaY	The vertical (Y-axis) offset.

OnCurrentSelectionAfterDelete(EventArgs)

Declaration

protected virtual void OnCurrentSelectionAfterDelete(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

OnCurrentSelectionBeforeDelete(CancelEventArgs)

Declaration

protected virtual void OnCurrentSelectionBeforeDelete(CancelEventArgs e)

Parameters

Type	Name	Description
CancelEventArgs	e

OnCurrentSelectionTextChanged(TextChangedEventArgs)

Declaration

protected virtual void OnCurrentSelectionTextChanged(TextChangedEventArgs e)

Parameters

Type	Name	Description
TextChangedEventArgs	e

OnNewItemCreated(EventArgs)

Declaration

protected virtual void OnNewItemCreated(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

OnSelectionAreaChanged(EventArgs)

Declaration

protected virtual void OnSelectionAreaChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

OnSelectionChanged(EventArgs)

Declaration

protected virtual void OnSelectionChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

OnSelectionItemPropertyChanged(EventArgs)

Declaration

protected virtual void OnSelectionItemPropertyChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

Paste()

Pastes the content of the internal Clipborad on the editor surface.

Declaration

public void Paste()

Redo()

Performs a Redo action.

Declaration

public void Redo()

Save(Stream)

Saves the ThermalLabel object based on the current LabelDocument data and visual items to the specified stream.

Declaration

public void Save(Stream stream)

Parameters

Type	Name	Description
System.IO.Stream	stream	The stream where the ThermalLabel object will be saved.

Save(String)

Saves the ThermalLabel object based on the current LabelDocument data and visual items to the specified file name.

Declaration

public void Save(string fileName)

Parameters

Type	Name	Description
System.String	fileName	A string that contains the name of the file (full path) to which to save the ThermalLabel object.

SelectAll()

Selects all the items on the editor's surface.

Declaration

public void SelectAll()

SelectItemByIndex(Int32)

Selects an item by its index number (zero-based) on the editor's surface.

Declaration

public void SelectItemByIndex(int itemIndex)

Parameters

Type	Name	Description
System.Int32	itemIndex	The index of the item to be selected.

SelectItemByName(String)

Selects an item by its name on the editor's surface.

Declaration

public void SelectItemByName(string itemName)

Parameters

Type	Name	Description
System.String	itemName	The name of the item to be selected.

SelectItemsByNames(String[])

Selects a set of items by their names on the editor's surface.

Declaration

public void SelectItemsByNames(string[] itemNames)

Parameters

Type	Name	Description
System.String[]	itemNames	The names of the items to be selected.

SelectItemsByTag(String)

Selects all the items matching the specified tag on the editor's surface.

Declaration

public void SelectItemsByTag(string tag)

Parameters

Type	Name	Description
System.String	tag	The tag of the items to be selected.

SelectItemsByType(String)

Selects all the items matching the specified Item Type on the editor's surface.

Declaration

public void SelectItemsByType(string itemType)

Parameters

Type	Name	Description
System.String	itemType	The Item Type of the items to be selected. Valid values are TextItem, BarcodeItem, ImageItem i.e. any class name derived from Item class.

SendBackward()

Sends the selected items one step toward the background of the label surface.

Declaration

public void SendBackward()

SendToBack()

Sends the selected items to the background of the label surface.

Declaration

public void SendToBack()

Undo()

Performs an Undo action.

Declaration

public void Undo()

UnlockSelectedItems()

Unlocks all the items in the current selection.

Declaration

public void UnlockSelectedItems()

UnselectAll()

Unselects all the selected items on the editor's surface.

Declaration

public void UnselectAll()

UpdateLabelDocument(SDK.Printing.UnitType, Double, Double, Int32)

Updates the LabelDocument object on the editor's surface.

Declaration

public void UpdateLabelDocument(SDK.Printing.UnitType unit, double width, double height, int numOfFractionalDigits)

Parameters

Type	Name	Description
SDK.Printing.UnitType	unit	The Unit of Measurement for the label document.
System.Double	width	The width of the label document.
System.Double	height	The height of the label document.
System.Int32	numOfFractionalDigits	The number of fractional digits to use with all floating-point values related to the label document.

UpdateLabelDocument(SDK.Printing.UnitType, Double, Double, Int32, Double, Double, Double, Int32, Double, Boolean)

Updates the LabelDocument object on the editor's surface.

Declaration

public void UpdateLabelDocument(SDK.Printing.UnitType unit, double width, double height, int numOfFractionalDigits, double gapLength, double markLength, double offsetLength, int labelsPerRow, double labelsHorizontalGapLength, bool isContinuous)

Parameters

Type	Name	Description
SDK.Printing.UnitType	unit	The Unit of Measurement for the label document.
System.Double	width	The width of the label document.
System.Double	height	The height of the label document.
System.Int32	numOfFractionalDigits	The number of fractional digits to use with all floating-point values related to the label document.
System.Double	gapLength	The vertical gap length between labels.
System.Double	markLength	The mark length or thickness between labels.
System.Double	offsetLength	The offset length or thickness between labels.
System.Int32	labelsPerRow	The number of labels per row in the media roll.
System.Double	labelsHorizontalGapLength	The horizontal gap length between labels when the media roll contains more than one label per row.
System.Boolean	isContinuous	Whether this document is on a continuous media roll i.e. labels are not separated by gaps, spaces, notches, slots, or holes.

UpdateSelectionItemsProperties()

Updates the properties of the selected items on the editor's surface.

Declaration

public void UpdateSelectionItemsProperties()

Remarks

When you present the selected items' properties to the end-user through some UI like a PropertyGrid control, a dialog box, etc. and the user modifies them, you must call this method so the changes are reflected on the selected items on the editor's surface.

Events

ClipboardStateChanged

Occurs when the state of the internal Clipboard changes.

Declaration

public event EventHandler ClipboardStateChanged

Event Type

Type	Description
System.EventHandler

Remarks

Handle this event to update the state of the classic Copy, Cut and Paste buttons of the UI by using the CanCopy, CanCut and CanPaste properties.

CurrentSelectionAfterDelete

Occurs just after the current item selection was deleted from the editor's surface.

Declaration

public event EventHandler CurrentSelectionAfterDelete

Event Type

Type	Description
System.EventHandler

CurrentSelectionBeforeDelete

Occurs just before the current item selection is being deleted from the editor's surface.

Declaration

public event CancelEventHandler CurrentSelectionBeforeDelete

Event Type

Type	Description
CancelEventHandler

CurrentSelectionTextChanged

Occurs when text content changes in the current selected TextItem.

Declaration

public event TextChangedEventHandler CurrentSelectionTextChanged

Event Type

Type	Description
TextChangedEventHandler

MouseDoubleClick

Occurs when a mouse button is clicked two times on the editor's canvas.

Declaration

public event MouseButtonEventHandler MouseDoubleClick

Event Type

Type	Description
MouseButtonEventHandler

NewItemCreated

Occurs when a new item is created on the editor's surface.

Declaration

public event EventHandler NewItemCreated

Event Type

Type	Description
System.EventHandler

SelectionAreaChanged

Occurs when the editor's selection area changes.

Declaration

public event EventHandler SelectionAreaChanged

Event Type

Type	Description
System.EventHandler

Remarks

Handle this event to present the selection's location and size to the end-user by using the CurrentSelectionArea property.

SelectionChanged

Occurs when the editor's selection changes.

Declaration

public event EventHandler SelectionChanged

Event Type

Type	Description
System.EventHandler

Remarks

Handle this event to present the selection data to the end-user by using the CurrentSelection property.

SelectionItemPropertyChanged

Occurs when any property of the selected item changes.

Declaration

public event EventHandler SelectionItemPropertyChanged

Event Type

Type	Description
System.EventHandler

UndoStateChanged

Occurs when the undo state of the editor changes.

Declaration

public event EventHandler UndoStateChanged

Event Type

Type	Description
System.EventHandler

Remarks

Handle this event to update the Undo and Redo buttons of the UI by using the CanUndo and CanRedo properties.