Erdusite Biconda Erdusite Yuitopek 138213-18

7/27/2019 Erdusite Biconda Erdusite Yuitopek 138213-18

1/15

NiceLabel Programming Guide September 2008

www.nicelabel.com Page 2226 of 298

Function Delete(ID As Long) As Boolean

See also :

Create, CreatePrompted, Remove

FindByID

Descript ion:

Returns the interface to the existing variable. Variable is selected with ID.

Syntax:

Function FindByID(ID As Long) As IVar

See also :

FindByName

FindByName

Descript ion:

Descript ion:

Returns the interface to the existing variable. Variable is selected with Name.

Syntax:Function FindByName(Name As String) As IVar

See also :

FindByID

FlushList

Descript ion:

FlushList method erases the whole variable list. If the operation was sucessfull TRUEvalue is returned.

Syntax:

Function FlushList() As Boolean

Item

Descript ion:

Returns the interface to the existing variable. Variable is selected with Index.


2/15



Syntax:

Function Item(Index As Long) As IVar

Remove

Descript ion:

Remove method removes a variable with specific ID from the variable list. In case ofsuccess TRUE result is returned.

Syntax:

Function Remove(ID As Long) As Boolean

See also :

Create, CreatePrompted, Delete

SetValues

Descript ion:

The IVariableList interface is extended to support setting multiple variable values with asingle command. The command is defined as:

Parameter Values should contain multiline value (one line for each variable). Each linemust be defined in format:

VariableName=VariableValue

The command will process each line and set the value for the variable. In case thevariable name is invalid (variable with that name does not exist),

the function will return an error.

In case the value is not valid for a variable, the function returns an error.

If en error is encountered, the processing of the functon will be terminated (remaininglines will not be processed).

Functon returns 0 if the processing completes successfully. If not, an error code isreturned and calling application can use ErrorID and ErrorMessage properties of theniceApp interface to process the error.

Syntax:

SetValues(Values As String)


3/15



2.9.26 Class ILabelSettings (Advanced Only)

Methods VersionAvailability

Properties VersionAvailability

SetLabelSize 4,5 Author 3,4,5

DefaultQuantity 4,5

Description 3,4,5

GapX 3,4,5

GapY 3,4,5

IsMultiband 3,4,5

LabelDimensionsUnit

3,4,5

LabelOffsetX 3,4,5

LabelOffsetY 3,4,5

LabelSizeX 3,4,5

LabelSizeY 3,4,5

NumberOfBands 3,4,5

Overlap 3,4,5

PageOffsetX 3,4,5

PageOffsetY 3,4,5

PageSizeX 3,4,5

PageSizeY 3,4,5

PaperFormat 3,4,5

PaperSizeX 3,4,5

PaperSizeY 3,4,5

PhysPageSizeX 3,4,5

PhysPageSizeY 3,4,5

PrintPages 3,4,5

RadiusX 3,4,5

RadiusY 3,4,5

Title 3,4,5

UGapX 3,4,5

UGapY 3,4,5

ULabelOffsetB 3,4,5

ULabelOffsetR 3,4,5


4/15



ULabelOffsetX 3,4,5

ULabelOffsetY 3,4,5

ULabelSizeX 3,4,5

ULabelSizeY 3,4,5

UOverlap 3,4,5

UPaperSizeX 3,4,5

UPaperSizeY 3,4,5

URadiusX 3,4,5

URadiusY 3,4,5

UGapY 3,4,5

WebX 3,4,5

WebY 3,4,5

Common to all properties:

All sizes are measured in the unit that is set in LabelDimensionsUnit if the property namehas "U" as the first letter of the name.

Author

Descript ion:

Returns the name of the author of the label

Syntax:

Property Author As String

DefaultQuantity

Descript ion:

Returns the default quantity, which is suggested before label production.

Syntax:

Property DefaultQuantity As Long

Access Rights:

read-only


5/15



Description

Descript ion:

Returns the description of the label.

Syntax:

Property Description As String

Access Rights:

read-only

GapX

Descript ion:

Returns the gap between the labels in mm/100 for the X axis.

UGapX - gap between the labels in LabelDimensionsUnit (X axis)

Syntax:

Property GapX As Long

Access Rights:

read-only

See also :

GapY

GapY

Descript ion:

Returns the gap between the labels in mm/100 for the Y axis.

UGapY - gap between the labels in LabelDimensionsUnit (Y axis)

Syntax:

Property GapY As Long

Access Rights:

read-only

See also :


6/15



GapX

IsMultiband

Descript ion:

Returns true if the label is desinged for multiband printing, otherwise result of the propertyis false.

Syntax:

Property IsMultiBand As Boolean

Access Rights:

read-only

See also :

NumberOfBands

LabelDimensionsUnit

Descript ion:

Returns the unit of measure used for the label settings.

Syntax:

Property LabelDimensionsUnit As String

Access Rights:

read-only

LabelOffsetX

Descript ion:

Returns the left offset, which is defined in the label.

ULabelOffsetR - right offset (calculated by NiceLabel)

Syntax:

Property LabelOffsetX As Long

Access Rights:

read-only


7/15



See also :

LabelOffsetY

LabelOffsetY

Descript ion:

Returns the top offset, which is defined in the label.

ULabelOffsetB - bottom offset (calculated by NiceLabel)

Syntax:

Property LabelOffsetY As Long

Access Rights:

read-only

See also :

LabelOffsetX

LabelSizeX

Descript ion:

Returns the height of the label.

ULabelSizeX represents the width of the label in defined units.

See also :

LabelSizeX

Syntax:

Property LabelSizeX As Long

Access Rights:

read-only

LabelSizeY

Descript ion:

Returns the width of the label.


8/15



ULabelSizeY represents the width of the label in defined units.

Syntax:

Property LabelSizeY As Long

Access Rights:

read-only

See also :

LabelSizeY

NumberOfBands

Descript ion:

Returns the number of bands, which are used in the label when multi-band label printingis enabled.

Syntax:

Property NumberOfBands As Long

Access Rights:

read-only

See also :

IsMultiband

Overlap

Descript ion:Overlapping of the labels when using multi-band label printing in mm/100

Syntax:

Property Overlap As Long

Access Rights:

read-only


9/15



PageOffsetX

Descript ion:

Offset for the unprintable area (X axis)

Syntax:

Property PageOffsetX As Long

Access Rights:

read-only

See also :

PageOffsetX

PageOffsetY

Descript ion:

Offset for the unprintable area (Y axis)

Syntax:

Property PageOffsetY As Long

Access Rights:

read-only

See also :

PageOffsetY

PageSizeX

Descript ion:

Returns the width of the printable page.

Syntax:

Property PageSizeX As Long

Access Rights:

read-only

See also :


10/15



PageSizeY

PageSizeY

Descript ion:

Returns the height of the printable page.

Syntax:

Property PageSizeY As Long

Access Rights:

read-only

See also :

PageSizeX

PaperFormat

Descript ion:

Returns the format of the paper. This is the dmPaperSize property from the DEVMODEstructure of the printer driver.

Syntax:

Property PaperFormat As Long

Access Rights:

read-only

PaperSizeX

Descript ion:

Returns the paper size. This is the dmPaperWidth * 10 property from the DEVMODEstructure of the printer driver.

UPaperSizeX - the information expressed in LabelDimensionsUnit

Syntax:

Property PaperSizeX As Long

Access Rights:read-only


11/15



See also :

PaperSizeY

PaperSizeY

Descript ion:

Returns the paper size. This is the dmPaperHeight * 10 property from the DEVMODEstructure of the printer driver.

UPaperSizeY - the information expressed in LabelDimensionsUnit

Syntax:

Property PaperSizeX As Long

Access Rights:

read-only

See also :

PaperSizeX

PhysPageSizeX

Descript ion:

Returns the whole width of the page.

Syntax:

Property PhysPageSizeX As Long

Access Rights:

read-only

See also :

PhysPageSizeY

PhysPageSizeY

Descript ion:

Returns the whole height of the page.


12/15



Syntax:

Property PhysPageSizeY As Long

Access Rights:

read-only

See also :

PhysPageSizeX

PrintPages

Descript ion:

Property returns true if the Print pages option is used in print dialog otherwise it returnsfalse. This option can be selected when printing multiple labels across.

Syntax:

Property RadiusX As Long

Access Rights:

read-only

RadiusXDescript ion:

Returns the radius value for the X axis of the label.

UradiusX in LabelDimensionsUnit (X axis)

Syntax:

Property RadiusX As Long

Access Rights:

read-only

See also :

RadiusX

RadiusY

Descript ion:


13/15



Returns the radius value for the Y axis of the label.

UradiusY in LabelDimensionsUnit (Y axis)

Syntax:

Property RadiusY As Long

Access Rights:

read-only

See also :

RadiusY

SetLabelSize

Descript ion:

Use this method if you want to change the label size and other label settings. What ispossible to set can be seen in the parameters.

Syntax:

Function SetLabelSize(LabelWidth As Long, LabelHeight As Long, LeftOffset As Long,

TopOffset As Long, RightOffset As Long, BottomOffset As Long) As Boolean

Access Rights:

read-write

Title

Descript ion:

Property retrieves the title of the label.

Syntax:

Property Title As String

Access Rights:

read-write


14/15



UGapX

Descript ion:

Property retrieves the GapX label setting in users measurment unit.

Syntax:

Property UGapX As String

Access Rights:

read-write

UGapY

Descript ion:

Property retrieves the GapY label setting in users measurment unit.

Syntax:

Property UGapY As String

Access Rights:

read-write

ULabelOffsetB

Descript ion:

Property retrieves bottom label offset setting in users measurment unit.

Syntax:

Property ULabelOffsetB As String

Access Rights:

read-write

ULabelOffsetR

Descript ion:

.


15/15



Syntax:

Property ULabelOffsetR As String

Access Rights:

read-write

ULabelOffsetX

Descript ion:

Property retrieves left label offset setting in users measurment unit.

Syntax:

Property ULabelOffsetX As String

Access Rights:

read-write

ULabelOffsetY

Descript ion:

Property retrieves top label offset setting in users measurment unit.

Syntax:

Property ULabelOffsetY As String

Access Rights:

read-write

ULabelOffsetR

Descript ion:

Property retrieves right label offset setting in users measurment unit.

Syntax:

Property ULabelOffsetR As String

Access Rights:

read-write

Erdusite Biconda Erdusite Yuitopek 138213-18

Documents

Transcript of Erdusite Biconda Erdusite Yuitopek 138213-18