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.

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

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 Font size (bottom) property specifies the font size of the bottom text on the control. Only applies if Font size mode is set to Fixed.

The Font size (main) property specifies the font size of the main text on the control. Only applies if Font size mode is set to Fixed.

The Font size (top) property specifies the font size of the top text on the control. Only applies if Font size mode is set to Fixed.

The Font size mode property specifies the method used to size the text on the control. Options include:

• Auto — Automatically size the text relative to the size of control.
• Fixed — Size the text using the values specified in the Font size property.

The default value is Auto. The default value for the text tool is Fixed.

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

The Marker height property specifies the height of the triangular marker for the point value on the donut.

The Marker width property specifies the width of the triangular marker for the point value on the donut.

The Tooltip property specifies the text that will appear on the control's tooltip, which can be a static label, or dynamic text based on point or facility attributes. Dynamic text is built using tokens, which can represent real-time CVS point properties, point configuration properties, and facility properties. Click to configure text and property strings using the CygNet Property String dialog box.

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

The Tooltip mode property specifies how the tool 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 Bottom information text property specifies the text that will appear on the bottom information area on the control, which can be a static label, or dynamic text based on point or facility attributes. Dynamic text is built using tokens, which can represent real-time CVS point properties, point configuration properties, and facility properties. Click to configure text and property strings using the CygNet Property String dialog box. The default value is the %Units% token.

The Text property specifies the text that will appear on the face of the control, which can be a static label, or dynamic text based on point or facility attributes. Dynamic text is built using tokens, which can represent real-time CVS point properties, point configuration properties, and facility properties. Click to configure text and property strings using the CygNet Property String dialog box. For most controls there is no default. For the detail, donut, and tile view controls the default value is the %Value% token.

The Color configuration box contains all the 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 explicitly configured (using <Self>) or it can be sourced from the point state of the associated point (by selecting Point State).

Options include:

• Source — Click to reveal two options:
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme. When Point State is selected the Color property disappears.
• Color — Only displays if the Source is <Self>. Click to explicitly specify a color using the color picker.

The Text color property specifies the color used for the text of the control. The color can be explicitly configured (using <Self>) or it can be sourced from the point state of the associated point (by selecting Point State).

Options include:

• Source — Click to reveal two options:
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme. When Point State is selected the Color property disappears.
• Color — Only displays if the Source is <Self>. Click to explicitly specify a color using the color picker.

The Ring color property specifies the color used for the outer ring that represents the point value in the donut. The color can be sourced from one of two options:

1. explicitly configured (using <Self>)
2. sourced from the point state of the associated point (by selecting Point State)

The default value is <Self>.

Options include:

• Source — Click to reveal two options:
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme. When Point State is selected the Color property disappears.
• Color — Only displays if the Source is <Self>. Click to explicitly specify a color using the color picker.

The Empty ring color property specifies the color used for the empty or unused ring in the donut. The color can be explicitly configured (using <Self>) or it can be sourced from the point state of the associated point (by selecting Point State).

Options include:

• Source — Click to reveal two options:
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme. When Point State is selected the Color property disappears.
• Color — Only displays if the Source is <Self>. Click to explicitly specify a color using the color picker.

The Marker color property specifies the color used for the value marker on the donut. The color can be sourced from one of two options:

1. explicitly configured (using <Self>)
2. sourced from the point state of the associated point (by selecting Point State)

The default value is <Self>.

Options include:

• Source — Click to reveal two options:
  • <Self> — Select <Self> to explicitly configure the color. When <Self> is selected a Color field and picker is automatically displayed beneath the Source field and must be configured.
  • Point State — Select Point State to specify that the source of the color corresponds to the point state color defined for the point represented in the element. The default point state colors for a CygNet system are defined by the system’s point scheme. When Point State is selected the Color property disappears.
• Color — Only displays if the Source is <Self>. Click to explicitly specify a color using the color picker.

The Use point state color? check box indicates whether to use the point state color for the alarm limit range. The default point state colors for a CygNet system are defined by the system’s point scheme.

The Date and time format property specifies the format for a point's timestamp using any of the valid .NET standard or custom numeric format strings. The date and time format applies to a point's Timestamp, Last Verified Change Timestamp, and Last Questionable Change Timestamp properties. Use this property to override the default format, which is configured on the Settings page of the Backstage view. The default format is YYYY/MM/DD HH:MM:SS.fff, which corresponds to 2019/01/01 10:20:30.0001. All timestamps are local client time.

The Display alarm ranges check box indicates whether to display alarm ranges for the setpoints for the associated point on the donut. The colors depicted for the ranges are randomly chosen from a predefined set of colors.

The Hide invalid tag check box indicates whether to hide the control if it resolves to an invalid or unknown tag.

The Point configuration property is used to configure the CygNet point associated with the control. Click to reveal a drop-down area where you can configure the Selection mode, source Facility tag, source SiteService, source Facility, and the UDC or Long Point ID for the point. Each option is described below.

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:

• 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.

Sending and receiving facility tags

Some controls on the same screen allow for the sending of facility tag information from one control to another.

1. On the sending control configure the Facility sender mode property to send facility tag information to another control on the same screen.
2. On the receiving control configure the Selection mode property (in either CygNet connection or Point configuration section) to Facility tag and select the Facility Source to the sending control.
3. On the receiving control configure a display tag that associates to a facility property, e.g. %FacilityTag%.

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 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 inherited 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. A SiteService selector is displayed:
    • SiteService — The SiteService property specifies the SiteService for which the control (or screen) is to display data. Click to select a service using the Select Service dialog box.
  • Screen — Select Screen to inherit the SiteService from the screen for this control. By default, the sender is the Screen control if no other senders have been configured.

The Point property is used to determine how the CygNet point will be configured. Click the appropriate radio button to reveal the desired field.

• UDC — The UDC property specifies the UDC for which the control is to display data. Click to select a UDC using the Select UDC dialog box.
• Long point ID — The Long point ID property specifies the long point ID of the CygNet point for which the control is to display data. Type the tag into the field.

The Show context menu check box indicates whether a right-click context menu will be available or suppressed in run mode. The default context menu will allow alarm acknowledgment, access to point history and alarm history, point configuration, and facility configuration.

The Value bounds configuration box contains all the options required to specify the lower and upper bound of the control. The source of the bounds can be either hard-coded to an explicit value (<Self>), or dynamically determined for each facility by sourcing the value from an application-specific attribute of the associated point (Point Attribute and then selecting an Indexed field or a General data field). A control on a templated screen supports different bounds for each source facility. By using a point attribute to store the bounds (for example, Indexed 1 for the lower value bound and Indexed 2 for the upper value bound), you can have a templated screen without having to script the control.

Click to reveal a set of options where you can specify the source and value of the lower and upper bound. The Value bounds configuration box consists of the following options.

The Lower value bound property specifies the lower value to use when filling the control.

The value bound can be explicitly configured (by selecting <Self>) or the value can be sourced from an application-specific attribute of the associated point (by selecting Point Attribute). Point application attributes are configured on the Application page of the CygNet PNT Editor. The following fields are available to store an attribute that can be used to indicate the value bound.

• Indexed attributes — A property that is included in a defined PNT index. This can be free-form text up to 15 characters. Three fields are available.
• General data attributes — A property that can be free-form text up to 20 characters. Three fields are available.

Options include:

• Source — Click to reveal two options:
  • <Self> — Select <Self> to explicitly configure the value bound in the Value field.
  • Point Attribute — Select Point Attribute to specify that the source of the value bound corresponds to a point attribute of the associated point represented in the control.
• Value — Configuration depends on the source:
  • If the Source is <Self>, select a number using the spin control. The default value is 0.
  • If the Source is Point Attribute, click to select from the following point attribute options: Indexed 1, Indexed 2, Indexed 3, General 1, General 2, or General 3.

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.