The Tab control supports the following properties, which are available via the Properties pane and the Canvas script editor. Click next to any property name in the Properties pane to see a short description for the selected property.
The Tab control supports the following properties, which are available via the Properties pane and the Canvas script editor. Click next to any property name in the Properties pane to see a short description for the selected property.
See Accessing Screen Objects for more information about how to view control objects in script in the Canvas application.
You can click 
(Categorize), click 
(Alphabetical within Category) or click 
(Search) within the properties using the features located immediately above the properties list. The search box is useful to help locate a property when an object contains many properties. For clarity, when you enter a search term, items matching your entry string remain displayed and non-matching items are temporarily hidden. Clear the search box to display the full properties list again.
You can expand and collapse each property category by clicking 
or 
next to the group name or simply clicking anywhere in the category heading.
The following tables describe the property names visible in the Properties pane user interface (UI) and the corresponding script property name.
Property list in alphabetical order
|
| UI Property | Script Property | Description | |
|---|---|---|---|
| Name Type Style | |||
|
ControlName |
The Name property specifies the unique identifier for this control. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. Names cannot start with a number. The default value is the object name and the numeric instance. The control's Name is also displayed on the Controls view of the Screen pane. |
||
|
ControlType |
The read-only Type property displays the type for the control: Chart, Grid, Heat Map, Object Container, Tag Chooser, View, etc. … The control's Type is also displayed on the Controls view of the Screen pane. |
||
|
|
The Style property defines the style sheet applied to an object on a screen. A style sheet consists of a predetermined list of properties and property values configured for a particular control type.
Styles are created in two ways:
Tip: You can also change a control's Style on the Controls view of the Screen pane. |
||
Location
|
|||
|
Height |
The Height property specifies the height of the control (or screen). Tip: You can also change the height of a control using the Settings pane (click on the |
||
|
HorizontalResizeMode |
The Horizontal resize mode property specifies whether and how the control dynamically moves or resizes horizontally when the screen is resized in run mode. Options include:
The default value is None. |
||
|
Layer |
The Layer property specifies the layer for this control. Layers are used to show, hide, and edit multiple controls on one layer without affecting controls on another layer.
Tip: You can also edit a control's Layer on the Controls view of the Screen pane.
|
||
|
VerticalResizeMode |
The Vertical resize mode property specifies whether and how the control dynamically moves or resizes vertically when the screen is resized in run mode. Options include:
The default value is None. |
||
|
IsVisible |
The Visible check box indicates whether the control is visible in run mode. Tip: You can also change a control's Visible setting on the Controls view of the Screen pane. |
||
|
Width |
The Width property specifies the width of the control (or screen). Tip: You can also change the width of a control using the Settings pane (click on the |
||
|
X |
The X property specifies the location of the control along the horizontal axis. Use the up, down, left, and right arrow keys to nudge a control by 1 pixel. Arrow moves a control by 1 pixel. Ctrl+Arrow moves a control by 10 pixels. Ctrl+Shift+Arrow moves a control by 100 pixels. Tip: You can also change the location of the control using the Settings pane; click on the |
||
|
Y |
The Y property specifies the location of the control along the vertical axis. Use the up, down, left, and right arrow keys to nudge a control by 1 pixel. Arrow moves a control by 1 pixel. Ctrl+Arrow moves a control by 10 pixels. Ctrl+Shift+Arrow moves a control by 100 pixels. Tip: You can also change the location of the control using the Settings pane; click on the |
||
|
ZIndex |
The Z index property is used to determine the order in which controls are layered on top of each other. Controls with higher values will draw on top of those with lower values. The newest control added to a screen will always have the highest value and will be the top layer. Two or more controls can be on the same index (layer). Tip: You can also change the Z index of a control using the Settings pane (click on the |
||
| Script
|
|||
|
|
The Include in script check box indicates that the control will appear in the objects collection of the screen (if scripting is enabled). To optimize performance, best practice dictates that you only include the controls you need to manipulate via script. Other controls should be excluded. When you add an event to a control, it will be automatically added to script and the Include in script property (and the In Script check box on the Controls view) will be set to True. Tip: You can also change the Include in Script setting on the Controls view of the Screen pane. |
||
| Tab Control
|
|||
|
IsEnabled |
The Enabled check box indicates whether the control is enabled. The default value is True. |
||
|
SelectedIndex |
The Selected index property specifies a zero-based index for the selected tab. -1 indicates no tab is selected and no nested view will display in run mode. 0 indicates the first tab is selected; 1 indicates the second tab is selected; 2 indicates the third tab is selected; and so on. |
||
|
Tabs — the tab control tab SelectedTab — the currently selected tab SelectedTab.IsCanvasFile SelectedTab.IsStudioFile SelectedTab.IsValidFile SelectedTab.Label SelectedTab.ScreenFileSource SelectedTab.ScreenPath Screen — the displayed screen (Use SelectedTab.ScreenPath and SelectedTab.ScreenFileSource to modify the screen via script.)
|
The Tab Configuration dialog box displays the tabs that will appear at the top of the tab control, and each tab's properties: the tab name and the path to the screen that will show in the optional nested view. Click If the number of tabs exceeds the width of the tab control container, arrows are added at the left and right side to allow you to navigate to the tabs you can't see.
|
||
|
Tabs: Tab name |
|
The Tab name property specifies the label for the tab in the tab control. |
|
|
Tabs: Screen path |
|
The Screen path property specifies the screen that will open in the body of the tab control. Click Note: This control only supports Canvas screens in CygNet v9.4. It does not support the display of CygNet Studio screens (.csf). |
|
| Generic
|
|||
|
String |
The String property specifies a generic string property that can be used when scripting this control. Type a string and reference it in your script as necessary. |
||
|
YesNo |
The Yes/No property specifies a generic Boolean yes/no property that can be used when scripting this control. Click the check box to enable the property and reference it in your script as necessary. |
||
|
|
|
(Add a new style based on this control) next to the Style property, after you have configured property values in the Properties pane. See 
(Settings) to the right of the control in design mode) or on the 
to open 
