Class Item

An abstract base class that provides basic functionality for any descended Item class.

Inheritance

System.Object

Item

BarcodeItem

ImageItem

LiteralItem

MultipleSelectionItem

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 abstract class Item : IXmlTemplate, INotifyPropertyChanged

Fields

_cacheItemId

Declaration

protected string _cacheItemId

Field Value

Type	Description
System.String

_comments

Declaration

protected string _comments

Field Value

Type	Description
System.String

_dataField

Declaration

protected string _dataField

Field Value

Type	Description
System.String

_dataFieldFormatString

Declaration

protected string _dataFieldFormatString

Field Value

Type	Description
System.String

_dpi

Declaration

protected double _dpi

Field Value

Type	Description
System.Double

_editable

Declaration

protected bool _editable

Field Value

Type	Description
System.Boolean

_expression

Declaration

protected string _expression

Field Value

Type	Description
System.String

_groupName

Declaration

protected string _groupName

Field Value

Type	Description
System.String

_isDesignTime

Declaration

protected bool _isDesignTime

Field Value

Type	Description
System.Boolean

_locked

Declaration

protected bool _locked

Field Value

Type	Description
System.Boolean

_name

Declaration

protected string _name

Field Value

Type	Description
System.String

_printAsGraphic

Declaration

protected bool _printAsGraphic

Field Value

Type	Description
System.Boolean

_readonly

Declaration

protected bool _readonly

Field Value

Type	Description
System.Boolean

_resizable

Declaration

protected bool _resizable

Field Value

Type	Description
System.Boolean

_tag

Declaration

protected string _tag

Field Value

Type	Description
System.String

_unitType

Declaration

protected UnitType _unitType

Field Value

Type	Description
UnitType

_useCache

Declaration

protected bool _useCache

Field Value

Type	Description
System.Boolean

_visible

Declaration

protected bool _visible

Field Value

Type	Description
System.Boolean

_x

Declaration

protected double _x

Field Value

Type	Description
System.Double

_y

Declaration

protected double _y

Field Value

Type	Description
System.Double

Properties

CacheItemId

Gets or sets the ID which will be assigned to the item in the cache. It must be a unique ID value for each item. The ID must be 1 to 8 alphanumeric [A-Z][0-9] characters long. If it's empty, then a random ID will be assigned automatically at runtime. Default value is an empty string

Declaration

public string CacheItemId { get; set; }

Property Value

Type	Description
System.String

Comments

Gets or sets the comments associated to this item. Default is an empty string.

Declaration

public string Comments { get; set; }

Property Value

Type	Description
System.String

DataField

Gets or sets the name of the field from the data source that contains the values to bind to this item. Default value is an empty string

Declaration

public string DataField { get; set; }

Property Value

Type	Description
System.String

DataFieldFormatString

Gets or sets the string that specifies the display format for the value of the data field. Default value is an empty string

Declaration

public string DataFieldFormatString { get; set; }

Property Value

Type	Description
System.String

Remarks

The format syntax must be the same used for the System.String.Format() method of .NET Framework.

Dpi

Gets or sets the item resolution, in dots per inch.

Declaration

public double Dpi { get; set; }

Property Value

Type	Description
System.Double

Editable

Gets or sets whether this item can be edited in the visual editor surface. Default is true.

Declaration

public bool Editable { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

If an Item is not editable, this means that it cannot be modified nor removed in the visual editor. It acts as a mandatory item that cannot be edited by the end user.

Expression

Gets or sets an expression that will be evaluated when rendering this item. Default value is an empty string

Declaration

public string Expression { get; set; }

Property Value

Type	Description
System.String

GroupName

Gets or sets the group name which this item is part of. Default is empty.

Declaration

public string GroupName { get; set; }

Property Value

Type	Description
System.String

HasFixedContent

Declaration

protected virtual bool HasFixedContent { get; }

Property Value

Type	Description
System.Boolean

IsDesignTime

Gets or sets whether this item is in design time in the visual editor surface. Default is false.

Declaration

public bool IsDesignTime { get; set; }

Property Value

Type	Description
System.Boolean

Locked

Gets or sets whether this item cannot be inadvertently moved nor resized in the visual editor surface. Default is false.

Declaration

public bool Locked { get; set; }

Property Value

Type	Description
System.Boolean

Name

Gets or sets the programmatic identifier or name assigned to the item. Default value is an empty string

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

Remarks

The name of the Item must contain chars from [A-Z], [a-z], or [0-9] ranges; and it must start with an alphabetic char. Any other chars are not allowed.

In addition, the name must be unique.

PrintAsGraphic

Gets or sets whether the item's output is forced to be printed as a graphic. Default is false.

Declaration

public bool PrintAsGraphic { get; set; }

Property Value

Type	Description
System.Boolean

ReadOnly

Gets or sets whether the source content of this item can be changed or not. Default is false.

Declaration

public bool ReadOnly { get; set; }

Property Value

Type	Description
System.Boolean

Resizable

Gets or sets whether this item can be resizable in the visual editor surface. Default is true.

Declaration

public bool Resizable { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

If an Item is not resizable, this means that it cannot be resized in the visual editor.

Tag

Gets or sets an arbitrary string value that can be used to store custom information about this item. Default is an empty string.

Declaration

public string Tag { get; set; }

Property Value

Type	Description
System.String

UnitType

Gets or sets the Unit of Measurement for the item.

Declaration

public UnitType UnitType { get; set; }

Property Value

Type	Description
UnitType

UseCache

Gets or sets whether the item should be cached in the printer's memory. An item cannot be cached if it's bound to some data source field through the DataField property. Default value is false

Declaration

public bool UseCache { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

An item should be cached if it displays fixed or static content, for instance, items which display company logos, industry symbols, text messages, etc. By caching this kind of items, you will get a better printing performance.

Visible

Gets or sets whether the item is visible and printed. Default is true.

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean

X

Gets or sets the x-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)

Declaration

public double X { get; set; }

Property Value

Type	Description
System.Double

Y

Gets or sets the y-coordinate of the upper-left corner of the item relative to the upper-left corner of its container. Default value is 0 (zero)

Declaration

public double Y { get; set; }

Property Value

Type	Description
System.Double

Methods

Clone()

When overridden in a derived class, creates an exact copy of this Item object.

Declaration

public abstract Item Clone()

Returns

Type	Description
Item	The new Item object that this method creates.

ConvertToUnit(UnitType, Int32)

Converts the properties' values from the current Unit to the new specified Unit.

Declaration

public abstract void ConvertToUnit(UnitType unit, int numOfFractionalDigits = -1)

Parameters

Type	Name	Description
UnitType	unit	The new unit of measurement.
System.Int32	numOfFractionalDigits	The number of fractional digits.

OnPropertyChanged(Item, String)

Declaration

protected void OnPropertyChanged(Item sender, string propertyName)

Parameters

Type	Name	Description
Item	sender
System.String	propertyName

UpdateFrom(Item)

When overridden in a derived class, updates this Item object with the properties of the specified Item object.

Declaration

public abstract void UpdateFrom(Item item)

Parameters

Type	Name	Description
Item	item	The Item object that is used for updating this Item object.

Events

PropertyChanged

Occurs when a property value changes.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
PropertyChangedEventHandler