Jump to content

Decoration class: Difference between revisions

From LabVIEW Wiki
mNo edit summary
m Removed VI Sever Category from page
 
(One intermediate revision by the same user not shown)
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide Decoration Properties Table</span>
{{VIServerClassTables|4}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ Decoration Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|632CC03
| [[Decoration class/Colors property|Colors]]
|Colors of the decoration expressed in terms of (Foreground Color, Background Color) pair.
 
If the description is a text label, then you must set the Text Colors:BG Color property to transparent to see the decoration colors of an object.
 
You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property.
 
This property is similar to using the color picker to specify the foreground and background colors of the decoration.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632CC05
| [[Decoration class/BGColor property|BGColor]]
|Background color of the decoration.
 
You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property.
 
This property is an element of the Colors property.
 
This property is similar to using the color picker to specify the background color of the decoration.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632CC04
| [[Decoration class/FGColor property|FGColor]]
|Foreground color of the decoration.
 
You can set the color of the front panel object by wiring a hexadecimal number with the form RRGGBB or by wiring the color box constant to the property.
 
This property is an element of the Colors property.
 
This property is similar to using the color picker to specify the foreground color of the decoration.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632CC07
| [[Decoration class/OwningPane property|OwningPane]]
|Returns a reference to the owning pane of the referenced decoration.
 
For nested decorations, this property returns a reference to the owning pane of the object that contains the referenced decoration.
 
If the decoration is not on a pane, this property returns Not a Refnum.
|R
|X
|- style="background-color:#FFFFCC;"
|632CC00
| [[Decoration class/Size property|Size]]
|Bounding area of the decoration specified in terms of width and height in pixels.
 
This property is similar to setting the width and height of the decoration in the Resize Objects dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632CC02
| [[Decoration class/Height property|Height]]
|Height of the bounding area of the decoration in pixels.
 
This property is an element of the Size property.
 
This property is similar to the <b>Height</b> item in the Resize Objects dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632CC01
| [[Decoration class/Width property|Width]]
|Width of the bounding area of the decoration in pixels.
 
This property is an element of the Size property.
 
This property is similar to the <b>Width</b> item in the Resize Objects dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|632CC06
| [[Decoration class/Visible property|Visible]]
|Indicates whether the decoration is visible.
|R/W
|X
|}
</div>
 
==Methods==
''No Methods for this class.''
 
==Events==
''No Events for this class.''


== History ==
== History ==
Line 121: Line 24:
*[[VI Server]]
*[[VI Server]]


[[Category:VI Server]]
[[Category:VI Server Class]]
[[Category:VI Server Class]]

Latest revision as of 01:46, 8 May 2020

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name Decoration class
Class ID 4
Scope Basic Development Environment
Class Inheritance
Class Children


The Decoration class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide Decoration Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Decoration Properties Table
Property ID Long Name (English) Description R/W RTE
632CC00SizeBounding area of the decoration specified in terms of width and height in pixels.Read/WriteYes
632CC01Size:WidthWidth of the bounding area of the decoration in pixels.Read/WriteYes
632CC02Size:HeightHeight of the bounding area of the decoration in pixels.Read/WriteYes
632CC03ColorsColors of the decoration expressed in terms of (Foreground Color, Background Color) pair.Read/WriteYes
632CC04Colors:FG ColorForeground color of the decoration.Read/WriteYes
632CC05Colors:BG ColorBackground color of the decoration.Read/WriteYes
632CC06VisibleIndicates whether the decoration is visible.Read/WriteYes
632CC07Owning PaneReturns a reference to the owning pane of the referenced decoration.Read OnlyYes

Methods

This class has no methods or it inherits methods from its parent: GObject Class.

Events

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


History

Version Change(s)
LabVIEW 2018 More info to come.

See Also