newObjects Active Label Misc object

Obtained from the VisiLabel object:
m = VisiLabel.Misc;
The Misc object exposes the rest of the properties of the VisiLabel object. These are properties which do not fall in the other categories and are too important to be accessible directly from the VisiLabel object itself (i.e. they affect the Active Label general behavior and it is better to avoid changing them in a mistake).

Text command:

The text commands are used to represent objects and their settings in the saved label data. When the label is saved or uploaded (see How to Download and Upload) text commands are generated and packed in the specified format (see Misc.SaveFormat). The representation of the entire label with its elements can be also obtained programmatically through VisiLabel.TextCommands and VisiLabel.ObjectParams. The commands have simple syntax and can be generated from the application (just like a HTML output) where appropriate allowing the developer implement different tasks in any suitable way. The label can be instantiated from set of text commands (see the list of the different options to do this). The text commands can be feed into the control programmatically (see VisiLabel.TextCommands) or a download can be invoked (see VisiLabel.Src and VisiLabel.MergeSrc).

The Misc object is represented by the MISC text command. 

Members reference:

Units Long integer. Can be one of the following values:
0 - hi-metric. 1 unit = 1/100 millimeters (default).
1 - hi-English. 1 unit = 1/1000 inch.
2 - lo-metric. 1 unit = 1/10 millimeters.
3 - lo-English. 1 unit = 1/100 inch.

Note that changing the property will not change the values of the properties of the elements and other objects that specify sizes and locations. Thus if you change this property the label will grow or shrink visually. This makes it preferable to set this property only once - during the initialization or before doing any design work with the control. Why is that? As a product which is used by developers to implement tasks in their applications it is convenient to use integer values for sizes and locations even internally. Re-scaling the values back and forth when the units are changed will lead to precision loss.

SaveFormat Long integer. Specifies the format in which the label is stored/uploaded. Affects all the tasks that involve persistence - upload (see VisiLabel.Dst and VisiLabel.PostData) and saving in applications that can use the raw IPersistStreamInit exposed by the control.
In version 1.0 the supported values are:
1 - Binary text commands. The text commands are saved as zero-terminated UNICODE strings with a prefix specifying the format.
2 (default) - Multibyte (often referred as ANSI) text format. The text commands are saved each on a separate line. The file begins with a prefix specifying the format.
3 - Unicode text. The text commands are saved each on separate line. The file begins with a prefix specifying the format.
See the Data, file and command formats for more details.
HideNonPrintable Hides (true)/shows (false) the non-printable parts of the label. The non-printable area of the label is everything outside the label and within the specified margins. See the label coordinate space. As the non-printable space of the label on the screen can be used for comments, navigation links and other things by using this property the application can configure the screen representation of the label to fit its the specific needs.
LastLoadError Long integer. After a load operation such as instantiation, loading the label from URL (VisiLabel.Src or VisiLabel.MergeSrc) if the operation has ended with an error this property contains the line/text command on which the error has occured.
VisiLabel Returns the VisiLabel object to which the Misc object belongs.
ShowProperties Displays the property sheets for the Misc object giving the user the opportunity to change the settings.






newObjects Copyright 2001-2006 newObjects [ ]