GObject class: Difference between revisions
Started page |
(No difference)
|
Revision as of 23:36, 26 August 2019
| VI Server Class Information | |
|---|---|
| Return to VI Server Class Hierarchy | |
| Class Name | class |
| Class ID | {{{1}}} |
| Scope | |
| Class Inheritance |
This class is a top-level class. |
| Class Children | This class has no children. |
| |
This article is a stub. You can help LabVIEW Wiki by expanding it. Please improve this article if you can. |
The GObject class is a class in the VI Server Class Hierarchy, (see also VI Server).
Properties
Show/Hide GObject Properties Table
| Legend | |
|---|---|
| R/W | Readable/Writable Permissions |
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Property ID | Short Name (English) | Description | R/W | RTE |
|---|---|---|---|---|
| 632A80C | BasicObjectFlags | R/W | ||
| 632A803 | Bounds | Maximum bounding area of the object specified in terms of width and height in pixels.
For a front panel object, this property returns the dimensions of the rectangle enclosing all the visible object components, such as the control, caption, label, graph legends, and so on. You cannot use this property to change the size of an object. To change the size of an object programmatically, use more specific properties such as Text Width or Plot Area:Size. |
R | X |
| 632A805 | Area Height | Height of the maximum bounding area of the object in pixels.
This property is an element of the Bounds property. |
R | X |
| 632A804 | Area Width | Width of the maximum bounding area of the object in pixels.
This property is an element of the Bounds property. |
R | X |
| 632A817 | DependNames | R | ||
| 632A816 | DependPaths | R | ||
| 632A815 | MissingNames | R | ||
| 632A814 | MissingPaths | R | ||
| 632A808 | GrpMbrRefs() | R | X | |
| 632A806 | Grouped | R | X | |
| 632A80D | IsWizardLocked | R | X | |
| 632A807 | Locked | R | X | |
| 632A80B | MasterRect | Returns the coordinates of all the sides of the object excluding labels, captions, and other visible parts connected to the object. | R | X |
| 632A800 | Position | Position of the top left corner of the bounding rectangle of the object on the front panel window in terms of left and top coordinates.
The bounding rectangle of the object includes all visible parts of the object. For example, if the object label is visible and you wire the top coordinate to this property, LabVIEW positions the top of the label at the coordinate you wired. If the object label is not visible, LabVIEW positions the top of the remaining visible parts of the object at the coordinate you wired. Note LabVIEW sets the origin for this property when you create a VI. When you scroll the owning pane, the origin does not change but instead scrolls with the owning pane. If you do not move the object, this property returns the same coordinates for the object regardless of whether you scroll the owning pane. Use the Origin property with this property to calculate the current position of an object in relation to the owning pane. For most front panel objects, this property returns the position of the object relative to the origin of the owning pane. For panes, this property returns the position of the pane relative to the global panel coordinate system. If you attempt to reposition an object that is grouped with other objects, LabVIEW repositions only the object you specify, not the whole group. |
R/W | X |
| 632A801 | Left | Position of the left corner of the bounding rectangle of the object on the front panel window.
This property is an element of the Position property. Note For most front panel objects, this property returns the position of the object relative to the origin of the owning pane. For panes, this property returns the position of the pane relative to the global panel coordinate system. |
R/W | X |
| 632A802 | Top | Position of the top corner of the bounding rectangle of the object on the front panel window.
This property is an element of the Position property. Note For most front panel objects, this property returns the position of the object relative to the origin of the owning pane. For panes, this property returns the position of the pane relative to the global panel coordinate system. |
R/W | X |
| 632A80F | ResizeInfoResizeHoriz | R | X | |
| 632A810 | ResizeInfoResizeVert | R | X | |
| 632A812 | IncludeInResize | R | X | |
| 632A811 | ResizeDialogName | R | X | |
| 632A809 | Selected | Returns TRUE if the GObject is selected. | R/W | X |
| 632A80A | TotalRect | Returns the coordinates of all sides of the entire object including labels, captions, and other visible parts connected to the object. | R | X |
| 632A813 | UID | Returns the unique identifier (UID) for the object. UIDs are identifiers for LabVIEW objects and are always unique within the same VI. Inspect the UID of an object to verify that it is the exact object that you want to manipulate.
A UID is always associated with the same object, even after you save the VI. However, if you delete an object, LabVIEW might assign the UID for that deleted object to a different object in the future. To detect this situation and ensure each UID refers to the object that you expect, check the Class Name property or Label property of the object in addition to the UID. |
R | X |
Methods
Show/Hide GObject Methods Table
| Legend | |
|---|---|
| RTE | Available in the Run-Time Engine |
| Basic Development Environment | |
| VI Scripting | |
| Private | |
| Deprecated | |
| Method ID | Short Name (English) | Description | RTE |
|---|---|---|---|
| 632A407 | GetObjHelp | Returns the help information for the object. | X |
| 632A405 | Invalidate | X | |
| 632A404 | Launch Config | ||
| 632A400 | Move | Moves the object to the specified position.
Note If you attempt to move an object to the owning VI of another object, LabVIEW makes a copy of the object instead of moving the object. |
|
| 632A401 | ObjHighlight | Given a Gobject Reference, this method scrolls to and highlights the object. | X |
| 632A402 | Replace | Replaces the current object with a new object and returns a reference to the new object. Use only one of the following inputs to specify the new object: Style, Path, or Palette String. | |
| 632A403 | Replace No Attrib | Replaces the current object with a new object and returns a reference to the new object. Use only one of the following inputs to specify the new object: Style, Path, or Palette String. This method does not maintain any size or color attributes of the object you replace. | |
| 632A406 | ReplacePreferringStubDDOOnFP |
Events
No Events for this class.
History
| |
History information is needed. What changes have occured over previous versions? |
| Version | Change(s) |
|---|---|
| More info to come. |