Navigator Properties

The Navigator 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.

Categorizing, Sorting, and Finding Properties

You can click

(Categorize), click Alphabetize

(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 Down arrow

next to the group name or simply clicking anywhere in the category heading.

Navigator Properties

The following tables describe the property names visible in the Properties pane user interface (UI) and the corresponding script property name.

UI Property	Script Property	Description
Name	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.
Type	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.
Style		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. Click to reveal a drop-down menu of predetermined styles configured for the selected control. Select a desired style and its properties will be applied to the control. Alternately, you can create a new style based on other property values configured for the control. Or you can select <None> to remove subscription to any style. Styles are created in two ways: In the control's Properties pane. Click (Add a new style based on this control) next to the Style property, after you have configured property values in the Properties pane. See Add a new style based on a control for more information. In the Canvas Settings in the Backstage view. The default style for any control is configured in the Backstage view. See Manage style sheets in the Backstage view for more information. Tip: You can also change a control's Style on the Controls view of the Screen pane.
Height	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 (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.
Horizontal resize mode	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: None — No resizing occurs. Shift — The object will shift horizontally. Expand — The object will expand or shrink horizontally the same number of pixels as the screen. Proportional — The object expands or shrinks proportionally to the screen. The default value is None.
Layer	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. Type the name of the layer into the Layer field. All layers are listed on the Layers pane, where you can show and hide layers for the screen in design mode and run mode. Tip: You can also edit a control's Layer on the Controls view of the Screen pane. Note: Layer visibility can be controlled at runtime via the AddLayer, HideLayer, and ShowLayer methods on the Screen object.
Vertical resize mode	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: None — No resizing occurs. Shift — The object will shift vertically. Expand — The object will expand or shrink vertically the same number of pixels as the screen. Proportional — The object expands or shrinks proportionally to the screen. The default value is None.
Visible	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	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 (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.
X	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 (Settings) to the right of the control in design mode.
Y	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 (Settings) to the right of the control in design mode.
Z index	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 (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.
Include in 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.
Display mode	DisplayMode	The Display mode property specifies how to display the navigation menu when the screen is in run mode. By default, the navigation menu and the control's contents will adapt depending on the amount of available space. Options include: Minimal — The navigation menu shows and hides as you click the navigator icon () and all menu items are hidden when clicked Compact — Only the top-level menu icons display and sub-menu items are hidden when clicked Expanded — The top-level menu items always on display and sub-menu items are hidden when clicked The default value is Compact.
Icon size	IconSize	The Icon size property is used to set the dimensions of the menu icon. The range is 8 to 40 pixels. The default is 16 by 16 pixels.
Menu items	Items — the navigator menu item (NavigationItem) ActiveItem — the currently selected NavigationItem ActiveItem.File ActiveItem.IconPath ActiveItem.IconPathType ActiveItem.IsCanvasFile ActiveItem.IsChild ActiveItem.IsDefault ActiveItem.Isleaf ActiveItem.IsStudioFile ActiveItem.IsValidFile ActiveItem.Items ActiveItem.Parent ActiveItem.ScreenPath ActiveItem.ScreenPathType ActiveItem.TempFileDirPath Screen — the navigator menu's start screen	The Navigator Menu Configuration dialog box displays all the menu items that will appear in the navigator's menu, and each menu item's properties: label, screen path, whether this screen is the start screen, icon path, and an icon preview. Click to open the Navigator Menu Configuration dialog box.
Menu items: Menu item label		The Menu item label property specifies the label for an item in the navigator menu.
Menu items: Screen path		The Screen path property specifies the screen that will open in the body of the navigator. Click to select a screen from the Open Files dialog box, where you can access a CygNet APPS or BSS folder or a local or network Windows file-system folder. The option is not available for top-level menu items with sub-menu items. Note: This control only supports Canvas screens in CygNet v9.4. It does not support the display of CygNet Studio screens (.csf).
Menu items: Start screen		The Start screen check box indicates that this screen will be displayed in the Navigator when first opened. The option is not available for top-level menu items with sub-menu items.
Menu items: Icon path		The Icon path property specifies the icon to display to the left of a top-level menu item. Click to select an image file from the Open Files dialog box, where you can access a CygNet APPS or BSS folder or a local or network Windows file-system folder. This option is not available for sub-menu items.
Menu items: Icon preview		The Icon preview property displays a preview of the selected icon. This option is not available for sub-menu items.
Menu width	MenuWidth	The Menu width property specifies the width of the main navigator menu in expanded mode. The default value is 150 pixels. The minimum width is 40 pixels.
Sub-menu width	SubMenuWidth	The Sub-menu width property specifies the width of the expanded menu when a parent item is selected. The default value is 150 pixels. The minimum width is 40 pixels.
String	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.
Yes/No	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.

UI Property

Script Property

Description

Name Type Style

Name

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.

Type

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.

Style

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.

Click to reveal a drop-down menu of predetermined styles configured for the selected control.
Select a desired style and its properties will be applied to the control.
Alternately, you can create a new style based on other property values configured for the control.
Or you can select <None> to remove subscription to any style.

Styles are created in two ways:

In the control's Properties pane. Click (Add a new style based on this control) next to the Style property, after you have configured property values in the Properties pane. See Add a new style based on a control for more information.
In the Canvas Settings in the Backstage view. The default style for any control is configured in the Backstage view. See Manage style sheets in the Backstage view for more information.

Tip: You can also change a control's Style on the Controls view of the Screen pane.

Location

Height

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 Settings icon (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.

Horizontal resize mode

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:

None — No resizing occurs.
Shift — The object will shift horizontally.
Expand — The object will expand or shrink horizontally the same number of pixels as the screen.
Proportional — The object expands or shrinks proportionally to the screen.

The default value is None.

Layer

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.

Type the name of the layer into the Layer field.
All layers are listed on the Layers pane, where you can show and hide layers for the screen in design mode and run mode.

Tip: You can also edit a control's Layer on the Controls view of the Screen pane.

Note: Layer visibility can be controlled at runtime via the AddLayer, HideLayer, and ShowLayer methods on the Screen object.

Vertical resize mode

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:

None — No resizing occurs.
Shift — The object will shift vertically.
Expand — The object will expand or shrink vertically the same number of pixels as the screen.
Proportional — The object expands or shrinks proportionally to the screen.

The default value is None.

Visible

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

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 Settings icon (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.

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 Settings icon (Settings) to the right of the control in design mode.

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 Settings icon (Settings) to the right of the control in design mode.

Z index

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 Settings icon (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.

Script

Include in 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.

Navigator

Display mode

DisplayMode

The Display mode property specifies how to display the navigation menu when the screen is in run mode. By default, the navigation menu and the control's contents will adapt depending on the amount of available space. Options include:

Minimal — The navigation menu shows and hides as you click the navigator icon () and all menu items are hidden when clicked
Compact — Only the top-level menu icons display and sub-menu items are hidden when clicked
Expanded — The top-level menu items always on display and sub-menu items are hidden when clicked

The default value is Compact.

Icon size

IconSize

The Icon size property is used to set the dimensions of the menu icon. The range is 8 to 40 pixels. The default is 16 by 16 pixels.

Menu items

Items — the navigator menu item (NavigationItem)

ActiveItem — the currently selected NavigationItem

ActiveItem.File

ActiveItem.IconPath

ActiveItem.IconPathType

ActiveItem.IsCanvasFile

ActiveItem.IsChild

ActiveItem.IsDefault

ActiveItem.Isleaf

ActiveItem.IsStudioFile

ActiveItem.IsValidFile

ActiveItem.Items

ActiveItem.Parent

ActiveItem.ScreenPath

ActiveItem.ScreenPathType

ActiveItem.TempFileDirPath

Screen — the navigator menu's start screen

The Navigator Menu Configuration dialog box displays all the menu items that will appear in the navigator's menu, and each menu item's properties: label, screen path, whether this screen is the start screen, icon path, and an icon preview.

Click Open dialog box to open the Navigator Menu Configuration dialog box.

Menu items: Menu item label

The Menu item label property specifies the label for an item in the navigator menu.

Menu items: Screen path

The Screen path property specifies the screen that will open in the body of the navigator. Click Open dialog box to select a screen from the Open Files dialog box, where you can access a CygNet APPS or BSS folder or a local or network Windows file-system folder. The option is not available for top-level menu items with sub-menu items.

Note: This control only supports Canvas screens in CygNet v9.4. It does not support the display of CygNet Studio screens (.csf).

Menu items: Start screen

The Start screen check box indicates that this screen will be displayed in the Navigator when first opened. The option is not available for top-level menu items with sub-menu items.

Menu items: Icon path

The Icon path property specifies the icon to display to the left of a top-level menu item. Click Open dialog box to select an image file from the Open Files dialog box, where you can access a CygNet APPS or BSS folder or a local or network Windows file-system folder. This option is not available for sub-menu items.

Menu items: Icon preview

The Icon preview property displays a preview of the selected icon. This option is not available for sub-menu items.

Menu width

MenuWidth

The Menu width property specifies the width of the main navigator menu in expanded mode. The default value is 150 pixels. The minimum width is 40 pixels.

Sub-menu width

SubMenuWidth

The Sub-menu width property specifies the width of the expanded menu when a parent item is selected. The default value is 150 pixels. The minimum width is 40 pixels.

Generic

String

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.

Yes/No

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.