Jump to content

GObject class: Difference between revisions

From LabVIEW Wiki
← Older editNewer edit →
VisualWikitext
mNo edit summary
Replaced with template tables
Tag: Replaced
Line 8: Line 8:


==Properties==
==Properties==
<span class="mw-customtoggle-propertiestable">Show/Hide GObject Properties Table</span>
{{VIServerPropsTable|36}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ GObject Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#D1BB80;"
|632A80C
| [[GObject class/BasicObjectFlags property|BasicObjectFlags]]
|
|R/W
|
|- style="background-color:#FFFFCC;"
|632A803
| [[GObject class/Bounds property|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
|- style="background-color:#FFFFCC;"
|632A805
| [[GObject class/Area Height property|Area Height]]
|Height of the maximum bounding area of the object in pixels.
 
This property is an element of the Bounds property.
|R
|X
|- style="background-color:#FFFFCC;"
|632A804
| [[GObject class/Area Width property|Area Width]]
|Width of the maximum bounding area of the object in pixels.
 
This property is an element of the Bounds property.
|R
|X
|- style="background-color:#CCFFFF;"
|632A817
| [[GObject class/DependNames property|DependNames]]
|
|R
|
|- style="background-color:#CCFFFF;"
|632A816
| [[GObject class/DependPaths property|DependPaths]]
|
|R
|
|- style="background-color:#CCFFFF;"
|632A815
| [[GObject class/MissingNames property|MissingNames]]
|
|R
|
|- style="background-color:#CCFFFF;"
|632A814
| [[GObject class/MissingPaths property|MissingPaths]]
|
|R
|
|- style="background-color:#D1BB80;"
|632A808
| [[GObject class/GrpMbrRefs() property|GrpMbrRefs()]]
|
|R
|X
|- style="background-color:#D1BB80;"
|632A806
| [[GObject class/Grouped property|Grouped]]
|
|R
|X
|- style="background-color:#D1BB80;"
|632A80D
| [[GObject class/IsWizardLocked property|IsWizardLocked]]
|
|R
|X
|- style="background-color:#D1BB80;"
|632A807
| [[GObject class/Locked property|Locked]]
|
|R
|X
|- style="background-color:#CCFFFF;"
|632A80B
| [[GObject class/MasterRect property|MasterRect]]
|Returns the coordinates of all the sides of the object excluding labels, captions, and other visible parts connected to the object.
|R
|X
|- style="background-color:#FFFFCC;"
|632A800
| [[GObject class/Position property|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.
 
<b>Note</b>  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
|- style="background-color:#FFFFCC;"
|632A801
| [[GObject class/Left property|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.
 
<b>Note</b>  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
|- style="background-color:#FFFFCC;"
|632A802
| [[GObject class/Top property|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.
 
<b>Note</b>  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
|- style="background-color:#D1BB80;"
|632A80F
| [[GObject class/ResizeInfoResizeHoriz property|ResizeInfoResizeHoriz]]
|
|R
|X
|- style="background-color:#D1BB80;"
|632A810
| [[GObject class/ResizeInfoResizeVert property|ResizeInfoResizeVert]]
|
|R
|X
|- style="background-color:#D1BB80;"
|632A812
| [[GObject class/IncludeInResize property|IncludeInResize]]
|
|R
|X
|- style="background-color:#D1BB80;"
|632A811
| [[GObject class/ResizeDialogName property|ResizeDialogName]]
|
|R
|X
|- style="background-color:#CCFFFF;"
|632A809
| [[GObject class/Selected property|Selected]]
|Returns TRUE if the GObject is selected.
|R/W
|X
|- style="background-color:#CCFFFF;"
|632A80A
| [[GObject class/TotalRect property|TotalRect]]
|Returns the coordinates of all sides of the entire object including labels, captions, and other visible parts connected to the object.
|R
|X
|- style="background-color:#CCFFFF;"
|632A813
| [[GObject class/UID property|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
|}
</div>


==Methods==
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide GObject Methods Table</span>
{{VIServerMethodsTable|36}}
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ GObject Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#CCFFFF;"
|632A407
| [[GObject class/GetObjHelp method|GetObjHelp]]
|Returns the help information for the object.
|X
|- style="background-color:#D1BB80;"
|632A405
| [[GObject class/Invalidate method|Invalidate]]
|
|X
|- style="background-color:#D1BB80;"
|632A404
| [[GObject class/Launch Config method|Launch Config]]
|
|
|- style="background-color:#CCFFFF;"
|632A400
| [[GObject class/Move method|Move]]
|Moves the object to the specified position.
 
<b>Note</b>  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.
|
|- style="background-color:#FFFFCC;"
|632A401
| [[GObject class/ObjHighlight method|ObjHighlight]]
|Given a Gobject Reference, this method scrolls to and highlights the object.
|X
|- style="background-color:#CCFFFF;"
|632A402
| [[GObject class/Replace method|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: <b>Style</b>, <b>Path</b>, or <b>Palette String</b>.
|
|- style="background-color:#CCFFFF;"
|632A403
| [[GObject class/Replace No Attrib method|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: <b>Style</b>, <b>Path</b>, or <b>Palette String</b>. This method does not maintain any size or color attributes of the object you replace.
|
|- style="background-color:#D1BB80;"
|632A406
| [[GObject class/ReplacePreferringStubDDOOnFP method|ReplacePreferringStubDDOOnFP]]
|
|
|}
</div>


==Events==
==Events==
''No Events for this class.''
{{VIServerEventsTable|36}}


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occured over previous versions?}}
{{ambox|text=History information is needed.  What changes have occurred over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version

Revision as of 16:27, 8 September 2019

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name GObject class
Class ID 36
Scope Basic Development Environment
Class Inheritance
Class 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/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
GObject Properties Table
Property ID Long Name (English) Description R/W RTE
632A800PositionPosition of the top left corner of the bounding rectangle of the object on the front panel window in terms of left and top coordinates.Read/WriteYes
632A801Position:LeftPosition of the left corner of the bounding rectangle of the object on the front panel window.Read/WriteYes
632A802Position:TopPosition of the top corner of the bounding rectangle of the object on the front panel window.Read/WriteYes
632A803BoundsMaximum bounding area of the object specified in terms of width and height in pixels.Read OnlyYes (Read Only)
632A804Bounds:Area WidthWidth of the maximum bounding area of the object in pixels.Read OnlyYes (Read Only)
632A805Bounds:Area HeightHeight of the maximum bounding area of the object in pixels.Read OnlyYes (Read Only)
632A806GroupedRead OnlyYes
632A807LockedRead OnlyYes
632A808Group Member Refs[]Read OnlyYes
632A809SelectedReturns TRUE if the GObject is selected.Read/WriteYes
632A80ATotal Bounds RectReturns the coordinates of all sides of the entire object including labels, captions, and other visible parts connected to the object.Read OnlyYes
632A80BMaster Bounds RectReturns the coordinates of all the sides of the object excluding labels, captions, and other visible parts connected to the object.Read OnlyYes
632A80CBasic Object FlagsRead/WriteNo
632A80DIs Wizard LockedRead OnlyYes
632A80FResize Info:Can Resize HorizontallyRead OnlyYes
632A810Resize Info:Can Resize VerticallyRead OnlyYes
632A811Resize Info:Name in Resize DialogRead OnlyYes
632A812Resize Info:Include In ResizeRead OnlyYes
632A813UIDReturns 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.Read OnlyYes
632A814Dependencies:Missing Dependency PathsRead OnlyNo
632A815Dependencies:Missing Dependency NamesRead OnlyNo
632A816Dependencies:Found Dependency PathsRead OnlyNo
632A817Dependencies:Found Dependency NamesRead OnlyNo


Methods

Show/Hide GObject Properties Table

Legend
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
GObject Methods Table
Method ID Long Name (English) Description RTE
632A400MoveMoves the object to the specified position.No
632A401Object HighlightGiven a Gobject Reference, this method scrolls to and highlights the object.Yes (Read/Write)
632A402ReplaceReplaces 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.No
632A403Replace No AttributesReplaces 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.No
632A404Launch Config PageNo
632A405InvalidateYes
632A406Replace Preferring Stub DDO OnFPNo
632A407Get Help InfoReturns the help information for the object.Yes (Read/Write)


Events

This class has no events or it inherits events from its parent: Generic Class.


History

History information is needed. What changes have occurred over previous versions?
Version Change(s)
LabVIEW 2018 More info to come.

See Also

Retrieved from "https://labviewwiki.org/w/index.php?title=GObject_class&oldid=9662"