The Nested View 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.
Note: The Nested View control shares the same properties as the Object Viewer control, which is where a Canvas object is viewed in design mode. The Object Viewer's properties are listed in the Properties pane in an Object Viewer control and have the same properties, events, and methods as the Nested View control.
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 table describes the property names visible in the Properties pane user interface (UI) and the corresponding script property name.
|
|
| 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. |
|
| Nested View | ||
|
CygNetConfiguration |
The CygNet connection property is used to configure the facility and SiteService associated with this control or screen. Two selection modes are available: a) by Facility tag or b) by SiteService / Facility. This split configuration allows for the inheritance of these properties from other controls, or the specific configuration of the SiteService or the facility, while dynamically changing the other. This use case may be rare; therefore, the Facility tag option is the default. Click |
|
|
CygNetConfiguration.SelectionMode |
The Selection mode property is used to determine how the control will receive CygNet information from other controls. Two options are available; click the desired radio button:
Sending and receiving facility tagsSome controls on the same screen allow for the sending of facility tag information from one control to another.
|
|
|
CygNet connection: Facility tag CygNet connection: Facility |
CygNetConfiguration.Facility CygNetConfiguration.Facility.FacilityID CygNetConfiguration.Facility.FacilityID.IsBroadcastSourced CygNetConfiguration.Facility.FacilityID.IsOrderInType CygNetConfiguration.Facility.FacilityID.IsOrderInTypeAttributeConfigured CygNetConfiguration.Facility.FacilityID.IsRelative CygNetConfiguration.Facility.FacilityID.IsSelfSourced CygNetConfiguration.Facility.FacilityID.OrderInType CygNetConfiguration.Facility.FacilityID.RelativeFacilityLink CygNetConfiguration.Facility.FacilityID.ResolveRelativeFacility CygNetConfiguration.Facility.FacilityID.Source CygNetConfiguration.Facility.FacilityID.SourceFacilityID CygNetConfiguration.FacilityTag CygNetConfiguration.FacilityTag.FacilityId CygNetConfiguration.FacilityTag.Service CygNetConfiguration.FacilityTag.Site CygNetConfiguration.FacilityTag.SiteService CygNetConfiguration.FacilityTag.SiteService.Service CygNetConfiguration.FacilityTag.SiteService.Site CygNetConfiguration.SourceFacilityTag CygNetConfiguration.SourceFacilityTag.FacilityId CygNetConfiguration.SourceFacilityTag.Service CygNetConfiguration.SourceFacilityTag.Site CygNetConfiguration.SourceFacilityTag.SiteService CygNetConfiguration.SourceFacilityTag.SiteService.Service CygNetConfiguration.SourceFacilityTag.SiteService.Site CygNetConfiguration.SourceFacilityTagString FacilitySender |
The Facility tag or Facility property is where you specify the source of the facility for the control (or screen) to use. The source for the facility can be explicitly configured for this control or it can be inherited from another control on the same screen, or from the screen, or from another screen. Click
|
|
CygNetConfiguration.SiteService CygNetConfiguration.SiteService.DisplayString CygNetConfiguration.SiteService.DomainSiteService CygNetConfiguration.SiteService.DomainSiteService.DomainId CygNetConfiguration.SiteService.DomainSiteService.Service CygNetConfiguration.SiteService.DomainSiteService.Site CygNetConfiguration.SiteService.DomainSiteService.SiteService CygNetConfiguration.SiteService.DomainSiteService.SiteService.Service CygNetConfiguration.SiteService.DomainSiteService.SiteService.Site CygNetConfiguration.SiteService.IsBroadcastSourced CygNetConfiguration.SiteService.IsSelfSourced CygNetConfiguration.SiteService.SiteService CygNetConfiguration.SiteService.SiteService.Service CygNetConfiguration.SiteService.SiteService.Site CygNetConfiguration.SiteService.Source GetCygNetSiteServiceSenders GetCygNetSiteServiceSenders.Method GetCygNetSiteServiceSenders.Target SiteServiceSender |
The SiteService property is where you specify the source of the SiteService for the control (or screen) to use. The source for the SiteService can be explicitly configured for this control or it can be inherited from another control on the same screen, or from the screen, or from another screen. Click
|
|
|
FileSource |
This property specifies the source to the file, image, object file, or screen. Options include:
The default file source is Local. |
|
|
File IsCanvasFile IsStudioFile IsValidFile Screen ScreenPath |
This property specifies the path to the file, image file, object file, or screen file. Depending on the selection in the source property the type of path is different. Click
Linking between Canvas screens, objects, and nested views is quite flexible. You don't need to specify the service or folder information in the path to find related screens, objects, or nested views, although you can if desired. When specifying a path to another file, the following notes apply: If the screen or object file is in the APPS or BSS, you can specify the:
If the screen or object file is in the local file system, you can specify the:
|
|
| 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. |
|