Jump to content

Template:VIServerPropsTable

From LabVIEW Wiki
Revision as of 01:00, 30 August 2019 by Q (talk | contribs) (Starting Templates)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


Usage

Use this template is for VI Server Class Hierarchy class pages. This template supports named parameters to customize contents:

Parameter Description Default
{{{1}}} The class name.
{{{2}}} Array of Rows using the template, Template:VIServerPropTableRow Blank or null means there are no properties. The table won't be displayed, instead the text: "No Properties for this class." is displayed.

Example: No Properties Exists

{{VIServerPropsTable}}


No Properties for this class.



Example: Properties Exist

{{VIServerPropsTable|Control| {{VIServerPropTableRow|Control|Auto-Update|633201C|script|R/W|X|If TRUE, the control automatically updates when the type definition changes.}} {{VIServerPropTableRow|Control|Blinking|6332003|basic|R/W|X|If TRUE, the control blinks. Keep in mind the following caveats when using this property: *If you set this property to TRUE for system controls, the controls might not blink correctly. System controls are designed specifically for use in dialog boxes and are not designed to blink because standard dialog boxes usually do not contain blinking controls. *You cannot use this property with XControls or controls on a subpanel. *Do not use this property with elements in an array. This property works on only one element in the array, not the entire array. Use a cluster instead of an array to make all the elements blink. This property is similar to the <b>Blink Foreground</b> and <b>Blink Background</b> options on the Environment page of the Options dialog box, and to the <b>Blink delay for front panel controls (milliseconds)</b> option on the Front Panel page of the <b>Options</b> dialog box.}} }}


Show/Hide Control Properties Table


Example: Can't use with nested tables

{{VIServerPropsTable|Control| {{VIServerPropTableRow|Control|BindingStatus|633202A|script|R|X|Returns the status of the data connection. The connection status can be Invalid Status, Unconnected, Active, Idle, Error, or Connecting. <table class="wikitable"> <caption style="text-align:left;">Elements:</caption> <tr><th scope="col" style="text-align:left;">Name</th> <tr><th scope="col" style="text-align:left;">Description</th></tr> <tr style="vertical-align:top;"> <td scope="row" style="text-align:left;">Code</td> <td>The connection status. Valid values are Invalid Status, Unconnected, Active, Idle, Error, or Connecting.</td></tr> <tr style="vertical-align:top;"> <td scope="row" style="text-align:left;">Text</td> <td>Displays a message describing the current status.</td></tr></table>}} }}


Show/Hide Control Properties Table