Jump to content

Scrollbar class: Difference between revisions

From LabVIEW Wiki
mNo edit summary
Replaced with template tables
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 Scrollbar Properties Table</span>
{{VIServerClassTables|90}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ Scrollbar Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|66F4C005
| [[Scrollbar class/CoerceMax property|CoerceMax]]
|Coerces the scroll bar value to Doc Max when the value is greater than the maximum value of the scrolling range.
 
If FALSE, you can increment the scroll bar value out of the scrolling range by clicking the increment arrow. This property is similar to the Coerce option in the <b>Maximum</b> pull-down menu on the Data Entry page of the <b>Scrollbar Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|66F4C004
| [[Scrollbar class/CoerceMin property|CoerceMin]]
|Coerces the scroll bar value to Doc Min when the value is less than the minimum value of the scrolling range.
 
If FALSE, you can decrement the scroll bar value out of the scrolling range by clicking the decrement arrow.
 
This property is similar to the Coerce option in the <b>Minimum</b> pull-down menu on the Data Entry page of the <b>Scrollbar Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|66F4C001
| [[Scrollbar class/DocMax property|DocMax]]
|Maximum value of the scrolling range.
 
You can set the maximum value of the scrolling range to be less than the minimum value if you want the scrolling range to scroll from Doc Max to Doc Min. If you do not coerce Doc Max, you can increment the scroll bar value out of the scrolling range by clicking the increment arrow. The top or left position of the scroll box determines the value of the scroll bar. If Doc Min is 0, Doc Max is 10, and Page Size is 2, the scrolling range is 0 to 8.
 
This property is similar to the Maximum option on the Data Entry page of the <b>Scrollbar Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|66F4C000
| [[Scrollbar class/DocMin property|DocMin]]
|Minimum value of the scrolling range.
 
You can set the minimum value of the scrolling range to be greater than the maximum value if you want the scrolling range to scroll from Doc Max to Doc Min. If you do not coerce Doc Min, you can decrement the scroll bar value out of the scrolling range by clicking the decrement arrow. The top or left position of the scroll box determines the value of the scroll bar. If Doc Min is 0, Doc Max is 10, and Page Size is 2, the scrolling range is 0 to 8.
 
This property is similar to the Minimum option on the Data Entry page of the <b>Scrollbar Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|66F4C007
| [[Scrollbar class/HousingLength property|HousingLength]]
|Length of the housing in pixels.
|R/W
|X
|- style="background-color:#FFFFCC;"
|66F4C002
| [[Scrollbar class/Increment property|Increment]]
|Increment value of the scrolling range. When you click the increment and decrement arrows, the scroll bar value adds or subtracts the increment value to move the scroll box toward the arrow that you click.
 
If you set this property less than or equal to 0, incrementing by clicking the arrows uses the increment value of 1.
 
This property is similar to the Increment option on the Data Entry page of the <b>Scrollbar Properties</b> dialog box.
|R/W
|X
|- style="background-color:#FFFFCC;"
|66F4C003
| [[Scrollbar class/PageSize property|PageSize]]
|Page size of the scrolling range. When you click the spaces between the scroll box and the arrows, the scroll bar value changes by the page size.
 
The top or left position of the scroll box determines the value of the scroll bar. If Doc Min is 0, Doc Max is 10, and Page Size is 2, the scrolling range is 0 to 8. If you set this property less than or equal to 0, LabVIEW coerces the value to 1.
 
This property is similar to the Page size option on the Data Entry page of the <b>Scrollbar Properties</b> dialog box.
|R/W
|X
|- style="background-color:#CCFFFF;"
|66F4C006
| [[Scrollbar class/Rep property|Rep]]
|Use this property to get or set data types on a scrollbar control.
|R/W
|X
|}
</div>
 
==Methods==
''No Methods for this class.''
 
==Events==
''No Events for this class.''


== History ==
== History ==

Revision as of 22:36, 8 September 2019

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

This class has no children.


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

Properties

Show/Hide Scrollbar Properties Table

Legend
R/WReadable/Writable Permissions
RTEAvailable in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated
Scrollbar Properties Table
Property ID Long Name (English) Description R/W RTE
66F4C000Doc MinMinimum value of the scrolling range.Read/WriteYes
66F4C001Doc MaxMaximum value of the scrolling range.Read/WriteYes
66F4C002IncrementIncrement value of the scrolling range. When you click the increment and decrement arrows, the scroll bar value adds or subtracts the increment value to move the scroll box toward the arrow that you click.Read/WriteYes
66F4C003Page SizePage size of the scrolling range. When you click the spaces between the scroll box and the arrows, the scroll bar value changes by the page size.Read/WriteYes
66F4C004Coerce Minimum ValueCoerces the scroll bar value to Doc Min when the value is less than the minimum value of the scrolling range.Read/WriteYes
66F4C005Coerce Maximum ValueCoerces the scroll bar value to Doc Max when the value is greater than the maximum value of the scrolling range.Read/WriteYes
66F4C006RepresentationUse this property to get or set data types on a scrollbar control.Read/WriteYes (Read Only)
66F4C007Housing LengthLength of the housing in pixels.Read/WriteYes

Methods

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

Events

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


History

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

See Also