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

The Color configuration property is used to configure color settings for the header and background of the Note Grid. Click to reveal a set of color options where you can specify the source and color to be used, which are described below:

• Header background color
• Header text color
• Grid background color

The Header background color property specifies the color used for the background of the grid's header row. The color can be sourced from one of two options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto), or b) the color can be customized (by selecting Self). The default value is Auto. 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 Header text color property specifies the color used for the text on the grid's header row. The color can be sourced from one of two options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto), or b) the color can be customized (by selecting Self). The default value is Auto. 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 Grid background color property specifies the color used for grid's background. The color can be sourced from one of two options provided in the Source drop-down menu: a) the color will automatically follow the selected application theme regardless of the underlying color palette and cannot be customized (by selecting Auto), or b) the color can be customized (by selecting Self). The default value is Auto. 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 Grid Column Configuration dialog box contains the properties required to configure each column in your Note Grid. There are two types of columns that can be configured in a Note Grid: a Facility column and a Note column. The number of defined columns is listed on the property label once all are configured.

Click to open Grid Column Configuration dialog box.

Column Order

Once defined, columns can be easily reordered by selecting, then dragging and dropping the item to a new location.

Column Types

Column configuration > Common property group (All column types)

The Name specifies the name that appears in the column header.

The Type property is a read-only text box that shows the column Type for the grid.

The Visible check box indicates whether to display the column in run mode.

The Width property specifies the width of the column in pixels. Set the value to 0 to auto size the width. If the column width is not configured (i.e., the width is set to 0), the column will be auto sized. If the column width is configured with a fixed column width, no resizing will occur.

The Text alignment property specifies the horizontal alignment of the text in the column (all column types except Image). The options are Left, Right, Center, and Justify. The default value is Left. When published to TWC the Justify option is indistinguishable from the Left option.

The Sort numerically property specifies whether this column can be sorted numerically (all column types except History and Image). In run mode, clicking a column header moves between the three states: sort ascending, sort descending, and unsorted. A small arrow indicates the sort order.

Column configuration > Facility property group

The Facility attribute property specifies the facility attribute that will displayed in the column. Click to reveal a drop-down menu of all available CygNet facility attributes categorized by type:

• Facility: General Attributes (The default value is Facility Description.)
• Facility: Text Attributes
• Facility: Table-driven Attributes
• Facility: Yes/No Attributes

Click to expand each category and select the desired facility attribute.

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.

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.

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.

Column configuration > Color property group

The Background color property specifies the color used for the background of the Note Grid cell.

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 of the Note Grid cell. The text color is sometimes known as the foreground color.

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 background of the Note Grid cell.

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.

Column configuration > Note property group

The Note attribute property specifies the note attribute that will displayed in the column. Click to reveal a drop-down menu of all available CygNet note attributes categorized by type:

• Note: General Attributes (The default value is Note Summary.)
• Note: Text Attributes
• Note: Table-driven Attributes
• Note: Yes/No Attributes

Click to expand each category and select the desired note attribute.

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.

The Facility sender mode property determines how facilities are sent to other controls. There are four options:

• None — No facilities are sent. This is the default value.
• Single click — A single click on a row will send a single facility to a receiving control on the same screen.
• Double click — A double click on a row will send a single facility to a receiving control on the same screen. This option supports two actions when a row is double-clicked: 1. Sending a facility to anther control on the same screen; and 2. Sending a facility to another screen. See the note below.
• All facilities — As soon as all facilities are received they will be sent to the receiving control on the screen. No click is required.

The Note type property specifies the user-defined note type to be displayed in the Note Grid. Notes can be categorized by type to provide a way to define the kinds of notes appropriate to your organization, to more easily filter existing notes, and to comprise an entire note when only a simple label adequately describes a note. Type the note type defined in your NOTE service. Leave empty to display all notes.

The Row configuration property is where you specify the source of the facility data to use for the rows of the Note Grid. The source for the facilities can be explicitly configured <Self>, received from the Screen or another control. If the Facility source is set to <Self>, facilities can be filtered as necessary, and you need to provide a SiteService. Click to reveal a drop-down area where you can configure the source Facility for the grid's rows.

Each option is described below.

The Facility property specifies the source facility for the grid's rows. 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, which can be further filtered,.
  • 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.
• Filter —

  The Facility filter option is visible only if the Facility Source is <Self>.

  Use the Facility filter property to limit the data presented in the control (or row or layer) to any CygNet facility attribute set up for your CygNet installation. Click to open the Facility Filter dialog box where you can create a custom filter rule. The filter rule is displayed in the property label; you do need to open the Facility Filter dialog box to edit the rule.

• SiteService — The SiteService option is visible only of the Facility Source is <Self>.

  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.

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.