The Object 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: In script, the Object container is always referred to as Screen.
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.
|
|
| UI Property | Script Property | Description | |
|---|---|---|---|
| Name and Type | |||
|
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. |
||
| Screen |
|||
|
BackgroundColor |
The Background color property specifies the background color of the screen, object, or control. Click |
||
|
ColorPalette ColorPalette.ColorPaletteId ColorPalette.ColorPaletteDescription |
The Color palette property specifies the color palette to use for the CygNet-aware controls on this screen. Select the desired palette from the drop-down menu. Select None to use the default CygNet point state colors. This is the default value. See Configuring Color Palettes for more information. |
||
|
IsPanZoomControlsVisible |
The Is pan zoom control visible check box indicates whether to display the pan zoom control on the screen in run mode. Pan and zoom are always enabled in design mode; the control is optional in run mode. |
||
|
IsPanZoomEnabled |
The Is pan/zoom enabled check box indicates whether the user can pan around or zoom in and out of the screen. Pan and zoom are always enabled in design mode; the control is optional in run mode. Note: Enabling this will negatively impact screen load performance and disable the ability to dynamically add controls via script. Note: The new run mode implemented in Canvas v9.4 does not support panning and zooming. Thus, Canvas has retained the old method of running screens for backwards compatibility. If you need to pan and zoom on a specific screen (configured via the IsPanZoomEnabled property on a screen), you will not be able to take advantage of the performance improvements the new run mode supports. The legacy run mode is accessible from the Run icon on the Canvas toolbar: Run > Run current screen (Legacy). |
||
|
Title |
The Title property specifies the title of this screen. |
||
|
UniqueName |
The Unique name property specifies a unique name for the screen which is used when creating an assembly for the screen's script. When a screen is saved, any script assemblies are compiled into a uniquely named .dll file and added to the .can file, so the script does not have to be recompiled every time the screen is run. When a screen is loaded in Canvas preview or Canvas View, the precompiled .dll is extracted to a temp directory and the script assembly is loaded from disk resulting in faster load times by removing the need to recompile script. This property specifies that unique name. Under most circumstances, this will not need to be changed and can be ignored. |
||
| Chart Date Range |
|||
|
DateStart DateStart.Date DateStart.Day DateStart.DayOfWeek DateStart.DayOfYear DateStart.Hour DateStart.Kind DateStart.Millisecond DateStart.Minute DateStart.Month DateStart.Second DateStart.Ticks DateStart.TimeOfDay DateStart.Year |
The Begin date (or Start or Start date) property specifies the start date and time for a control (or screen or chart or column) for an absolute date and time view window. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to the screen. Click |
||
|
RelativeStart |
The Begin relative date (or Relative start date or Start) property specifies a wildcard string defining the amount of time by which to adjust the start date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative start date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time. |
||
|
DateEnd DateEnd.Date DateEnd.Day DateEnd.DayOfWeek DateEnd.DayOfYear DateEnd.Hour DateEnd.Kind DateEnd.Millisecond DateEnd.Minute DateEnd.Month DateEnd.Second DateEnd.Ticks DateEnd.TimeOfDay DateEnd.Year |
The End date (or End) property specifies the end date and time for a control (or screen or chart or column) for an absolute date and time view window. The format is MM/DD/YYYY hh:mm:ss AM/PM. The default value is the system date and time at which the control was first added to the screen. Click |
||
|
RelativeEnd |
The End relative date (or Relative end date or End) property specifies a wildcard string defining the amount of time by which to adjust end date and time. The space-separated elements in this string must be of the form: "x-#", "x+#", or "x=#" where # is an integer and x is one of the following unit specifiers: y — Year, m — Month, d — Day, H — Hour, M — Minute, S — Second, and # is an integer. T wildcard is also supported and must be in the form: T, T+#, T-#, where T represent today at midnight, T-1 is yesterday at midnight, and T+1 is tomorrow at midnight, etc. Any integer can be used. For example, H-8 represents data from the 8 hours before the current hour, d+3 represents data 3 days after the current day, and d+2 H+1 M+30 represents data 2 days, 1 hour and 30 minutes after the current date and time. d-4 H=6 sets the relative end date and time to four days ago (d-4) at 6:00 a.m. (H=6). See Date and Time Wildcards for more information about adjusting relative time. |
||
|
OverrideChartDates |
The Override chart dates check box indicates whether to use the screen's dates, when displaying charts for this screen. |
||
|
UseRelativeTime |
The Use relative date check box indicates whether to use relative dates and time for the chart. Use the Begin/Start and End properties to specify the relative date ranges to use in the chart. If Use relative date is unchecked all dates and time will be absolute. Use the Begin/Start and End properties to specify the absolute date ranges to use in the chart. |
||
| CygNet |
|||
|
IsBroadcastingFacilities |
The Broadcast facilities check box indicates whether to notify other screens when this screen's facility selection changes. When enabled, and when a screen's facility selection changes, Canvas will broadcast the list of facilities out to all other screens open in the application that are configured to source their facility from <Broadcast>. See Interscreen Communication for more information about using this property. |
||
|
IsBroadcastingSiteService |
The Broadcast SiteService check box indicates whether to notify other screens when this screen's SiteService selection changes. When enabled, and when a screen's SiteService selection changes, Canvas will broadcast the SiteService out to all other screens open in the application that are configured to source their SiteService from <Broadcast>. See Interscreen Communication for more information about using this property. |
||
|
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 IsRelativeFacilityResolutionEnabled |
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 |
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
|
||
| Chart |
|||
|
DefaultChartFile |
The Default chart file property specifies the path to the chart file associated with this screen.
See Default Chart for more information. |
||
|
DefaultChartFileSource |
This property specifies the source to the file, image, object file, or screen. Options include:
The default file source is Local. |
||
| Facility Navigation |
|||
|
FacilityNavigationMode |
The Facility navigation mode (FacilityNavigationMode) property is included on the screen object to determine how a screen will handle a request to navigate to another screen via a facility. This property is used with the NavigateByFacility or OpenedViaHyperlink events to link to a facility's associated screen or replace a current screen in a Navigator control with a facility's associated screen. Click
The default value is Hyperlink - Open. See Navigation by Facility for more information about using this property. |
||
| Grid |
|||
|
GridColor |
The Grid color property specifies the color of the lines in the layout grid. Click |
||
|
GridHeight |
The Grid height property specifies the height of the layout grid. The default is 10 pixels high. |
||
|
GridWidth |
The Grid width property specifies the width of the layout grid. The default is 10 pixels wide. |
||
|
ShowGrid |
The Show grid property indicates whether to show the grid lines in design mode. By default the layout grid will be displayed. The grid will always be hidden in run mode. |
||
|
SnapToGrid |
The Snap to grid property indicates whether controls should snap to the grid. The default value is true. |
||
|
SnapToItems |
The Snap to items property indicates whether controls should snap to other controls. The default value is true. |
||
| General |
|||
|
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 |
||
|
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 |
||
| Global Settings |
|||
|
GlobalSettingsFile |
The Path property specifies the path to the global settings file. Depending on the selection in the source property the type of path is different. Click
|
||
|
GlobalSettingsSource |
This property specifies the source to the file, image, object file, or screen. Options include:
The default file source is Local. |
||
| Alarm Notifier |
|||
|
ShowAlarmBanner |
The Show alarm notifier property indicates whether the alarm notifier is visible on this screen when opened in Canvas View and Canvas View Lite. This property is set to true (On) by default and the alarm banner will always appear at the top of a screen in run mode, unless you turn it off in design mode. Note: Alarm sounds will still play in the screen, even if Show alarm notifier property is disabled (Off). |
||