The Name property specifies the unique identifier for this control. Valid characters are A-Z, 0-9, and underscore (_). Special characters and spaces are not permitted. Names cannot start with a number; an underscore will be prefixed if the control name starts 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.

The read-only Type property displays the type for the control: Button, Chart, CygNet Grid, Edit Box, Object Container, Search Box, Tag Chooser, etc. … The control's Type is also displayed on the Controls view of the Screen pane.

The Height property specifies the height of the control (or screen).

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.

The Layer property specifies the name of the layer to which this object is assigned. Layers can be 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 (the name can be a previously created layer or a new layer).
• All layers are listed on the Layers pane, where you can manage the layers for the screen in design mode and run mode.

The Lock property indicates whether the control is locked to the current position. A locked control cannot be moved via click and drag, or nudged with the arrow keys, or resized.

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.

The Visible check box indicates whether the control is visible in run mode.

The Width property specifies the width of the control (or screen).

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.

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.

The Color configuration drop-down contains all options required to specify the color properties of the control. Click to reveal a set of color options where you can specify the source of the color to be used for the elements of the control. The Color configuration box consists of the following options.

The Background color property specifies the color used for the background of the control.

The color can be sourced from one of two options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal two options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Self — Select Self to explicitly configure the color. When Self is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is Self. Click to customize the color using the color picker.

The Text color property specifies the color used for the text on the control or map visual.

The color can be sourced from one of two options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal two options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Self — Select Self to explicitly configure the color. When Self is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is Self. Click to customize the color using the color picker.

The Border color property specifies the color used for the border of the control.

The color can be sourced from one of two options provided in the Source drop-down menu:

1. The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). The default value is Auto.
2. The color can be customized (by selecting <Self>).

Options include:

For each color property select the Source and Color:

• Source — Click to reveal two options:
  • Auto — The color will automatically follow the selected client theme regardless of the underlying color palette (by selecting Auto). Where applicable, color-related properties will default to this configuration, allowing them to automatically follow the theme of the current client rather than fixing them to the one used when the screen was created. By using Auto for the color configuration, a screen developer can work in their preferred theme without affecting the presentation of the final screen when displayed by the user—avoiding display problems such as white text over a very light background, etc.

    Note:    Auto is not supported as a color source in TWC screens. If a property specifies Auto for color configuration, the screen will use the <Self> color that is specified in the Canvas file during the publishing process. See Color on TWC Screens.

  • Self — Select Self to explicitly configure the color. When Self is selected a Color field is automatically displayed beneath the Source field and must be configured.
• Color — Only displays if the Source is Self. Click to customize the color using the color picker.

The Custom Context Menu Configuration dialog box is where you configure any custom context menu items that will appear in the right-click context menu for the screen or control. Each custom context menu item will call an event into script so that you can customize screen or control behavior.

The custom context menu options will appear at the bottom of the fixed context menu options, separated by a line.

Each custom context menu item has a title and an event script ID; items can be designated as a separator; and custom context menus support nested menu items.

Click to open the Custom Context Menu Configuration dialog box.

The Title property specifies the menu name to be displayed in the runtime context menu.

The Is separator check box indicates whether this menu item will be a separator line in the menu at runtime. Once saved the separator has no configuration and no children. Separators do not have event IDs. Any event ID on a menu item when it’s converted to a separator is deleted. You can give it a title of 'Separator" or "----------" if desired.

The Script event ID specifies the event ID that will be called when the menu item is selected from the runtime right-click context menu. The event ID is passed in as a parameter into the Custom Context Menu Action event, along with other relevant information in the context of the click, for example, facility or point tag, as appropriate.

All CygNet communication to and from a remote device is performed using data groups. A data group is a collection of data group elements (DEIDs) logically grouped together for a specific purpose. Its primary function is to organize data received from and sent to field devices. All remote device and data group configuration information is stored in the CygNet DDS.

The Data group configuration property is used to configure the source facility and the CygNet data group to be polled when the DDS Button is clicked.

Click to reveal a drop-down area where you can configure the Selection mode, the source Facility tag, or the source SiteService and source Facility, to which the data group belongs, and the Data group(s). Each option is described below.

The Selection mode property is used to determine how the DDS Button will receive CygNet information from other controls or from itself. Two options are available; click the desired radio button:

• Facility tag — The Facility tag selector consists of a Source chooser and Resolve to a relative facility check box. If the Source is <Self> a Facility tag selector and relative facility options are also displayed. Facility tag is the default option.
• SiteService / Facility — The SiteService / Facility selector consists of Source and SiteService and Facility choosers.

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 received from another control on the same screen, or from the screen, or from another screen. Click to reveal the Facility tag or Facility selector. Options include:

• Source — Options include <Self>, Screen (default), or a list of Sender controls.
  • <Self> — Select <Self> to explicitly configure the facility for this control. A Facility tag or Facility selector is displayed, depending on the Selection mode:
    • Facility — The Facility property specifies the facility for which the control (or screen) is to display data. Click to select a facility using the Select Facility dialog box.
    • Facility Tag — The Facility tag property specifies the full facility tag identifier for which the control (or screen) is to display data. Click to select a facility using the Select Facility Tag dialog box.
  • Screen — Select Screen to inherit the facility from the screen for this control. By default, the sender is the Screen control if no other senders have been configured. Once Screen is selected Inherited from Screen will display for the Facility property.
  • Sender — A list of sender controls that have been configured with a facility will be displayed. Select the name of the control that will send its facility to this control. By default, the sender is the Screen control if no other senders have been configured. Once a sender control has been specified its name will display in the Source field.

• Resolve to a relative facility — The Resolve to a relative facility check box redirects the source of the facility to a relative facility, overriding the configured source facility. Once selected a list of configured Relative links is displayed. See Using Relative Facilities in Canvas for more information about configuring and scripting relative facility links.
  • Relative link — The Relative link property specifies a list of all available relative facility paths. Click to reveal a drop-down menu of all available relative facility definitions (relative links). Select a link from the list. If an order-in-type attribute is specified for the selected link, the Order in type field will display.
  • Order in type — The Order in type property specifies the attribute value used to represent the order in type (facility ordinal) if the relative facility definition is configured for one. It is possible to have multiple relative facility definition sets with the same definition name. In this case, if the specified Relative link is configured for ordinalization, then you need to configure the attribute value in the box.

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 received from another control on the same screen, or from the screen, or from another screen. Click to reveal the SiteService selector. Options include:

• Source — Options include <Self> or Screen (default):
  • <Self> — Select <Self> to explicitly configure the SiteService for this control or screen element. A SiteService selector is displayed:
    • SiteService — The SiteService property specifies the SiteService for which the control (or screen or screen element) is to display data. Click to select a service using the Select Service dialog box.
  • Screen — Select Screen to receive the SiteService from the screen for this control or screen element. By default, the sender is the Screen control if no other senders have been configured.

The Data group property is where you specify the data group(s) to be polled for transaction data by the DDS Button. Click to open the Configure Device Types and Data Groups dialog box, where you specify the Device type, Data group, and Ordinal. Multiple device types are supported.

The Device type property specifies the device type of the remote field device. This corresponds to the deviceType attribute in the device template’s device definition, and is the same value that appears in the Device Type column in the DDS view in CygNet Explorer.

The Data group property specifies the data group(s) to poll to get data from or to send data to a remote device.

The data group Ordinal property specifies the ordinal or instance of the data group type specified on the Data Group Properties page of the remote device editor. Each data group added to a remote device is identified by a number called an ordinal. If a remote device requires multiple instances of a data group, the group is defined only once in the device template file, but multiple instances of the data group, each with a unique ordinal, can be added in the device in the DDS.

The Get transaction on facility change check box indicates whether to get new transaction data whenever a source facility changes.

The Show transaction confirmation check box indicates whether to display a confirmation message showing when the transaction (Get or Send) has succeeded or failed.

This property specifies the path to the file, image file, video file, object file, or screen file. Depending on the selection in the source property the type of path is different. Click to access either the:

• Select File dialog box —To access an APPS or BSS folder
• Open File dialog box — To access a local or network file-system folder

This property specifies the source of the file, object file, screen file, image file, or video file. Options include:

• BSS — Indicates that the file is stored in an APPS or BSS folder
• Local — Indicates that the file is stored in a local or network file-system folder.

The Show image property indicates whether to display an image on the button.

The Size property indicates the size of the image on the control.

The Mouse cursor property determines which mouse cursor will appear when the mouse hovers over this control or map visual. Select an option from the drop-down menu: Arrow (), Hand (), Wait (), or Help (). The default cursor is the Arrow ().

The Suppress data retrieval check box indicates whether all CygNet data retrieval is suppressed for the control or map visual. Use this if you want to store point information in the control but don't want to automatically query services for data. Tokens will not be replaced and point state colors will be ignored.

You can configure the control with a valid point configuration but the control will not retrieve any CygNet data. This allows you to display static text for a control, while still allowing CygNet data context available from script.

If a control has a point configured, but Suppress data retrieval is enabled, Canvas won’t do much point processing. The one exception is point validity. If the control is configured to Hide invalid tag, then Canvas will check if the current tag is valid, even if Suppress data retrieval is enabled. This will allow you to configure some static text that will dynamically hide in the case of a templated screen for a facility that doesn’t have that particular point.

The Tooltip enabled property indicates whether to display a tooltip when the mouse hovers over the control or map visual.

The Tooltip mode property specifies how the tooltip will be displayed. Options include:

• Text — The tooltip displays as plain and/or tokenized text defined in the Tooltip property, using resolved point and facility properties.
• Object — The tooltip displays as a Canvas object, passing in the facility tag of the control.
• Script — A TooltipOpening event is fired to allow script to create a custom tooltip.

The default value is Text.

The Font size property specifies the font size of the text on the control or map visual.

The Text style property specifies the style to use for the text that appears on the control or map visual. Options include: Normal, Italic, or Oblique. The default value is Normal.

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.