Label Object

The label object represents the label of an object in Xpedition Designer.

The following table lists methods and properties of the Label object with links to the respective reference pages.

Table 1. Label Object Methods and Properties

Method or Property

Description

GetLocation Method (Label Object)Returns the coordinates of the label as a Point Object.
GetObjectColor Method (Label Object)Gets the color in which the label is drawn.
IsColorAutomatic Method (Label Object)Determines if the label has an automatic color set for it.
SetAutomaticColor Method (Label Object)Sets or unsets the color of a label object as the automatic color for labels.
SetLocation Method (Label Object)Specifies the coordinates for the label.
SetObjectColor Method (Label Object)Sets the color in which the label is drawn.
Application Property (Label Object)Returns the Application Object.
Font Property (Label Object)Returns or sets the font used for the label.
Orientation Property (Label Object)Returns or sets the orientation for the label.
Origin Property (Label Object)Returns or sets the coordinates for the origin of the label.
Parent Property (Label Object)Returns the parent object for the label (the object on which the label is placed).
ResolvedName Property (Label Object)Returns the text string of the label and fully resolves any nicknames.
Scope Property (Label Object)Returns or sets the scope of the label.
Selected Property (Label Object)Sets the selection status for the label.
Sense Property (Label Object)Returns or sets the sense of the label that specifies if signal is inverted or not inverted. A label drawn with an overbar indicates an inverted signal.
Size Property (Label Object)Returns or sets the size (text height) of the label.
TextString Property (Label Object)Returns or sets the text value of the label.
Type Property (Label Object)Returns the type value VDTS_LABEL, indicating that the object is, in fact, a label.
Visible Property (Label Object)Returns or sets the visibility of the label.