Object Container Properties

The Object Container 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.

Categorizing, Sorting, and Finding Properties

You can click

(Categorize), click Alphabetize

(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 Down arrow

next to the group name or simply clicking anywhere in the category heading.

Object Container Properties

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	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.
Type	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.
Style		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. Click to reveal a drop-down menu of predetermined styles configured for the selected control. Select a desired style and its properties will be applied to the control. Alternately, you can create a new style based on other property values configured for the control. Or you can select <None> to remove subscription to any style. Styles are created in two ways: In the control's Properties pane. Click (Add a new style based on this control) next to the Style property, after you have configured property values in the Properties pane. See Add a new style based on a control for more information. In the Canvas Settings in the Backstage view. The default style for any control is configured in the Backstage view. See Manage style sheets in the Backstage view for more information. Tip: You can also change a control's Style on the Controls view of the Screen pane.
Height	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 (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.
Horizontal resize mode	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: 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.
Layer	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. 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. Tip: You can also edit a control's Layer on the Controls view of the Screen pane. Note: Layer visibility can be controlled at runtime via the AddLayer, HideLayer, and ShowLayer methods on the Screen object.
Vertical resize mode	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: 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.
Visible	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	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 (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.
X	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 (Settings) to the right of the control in design mode.
Y	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 (Settings) to the right of the control in design mode.
Z index	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 (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.
Include in 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.
Background color	BackgroundColor	The Background color property specifies the background color of the screen, object, or control. Click to select a color using the color picker.
Control margin	ControlMargin	The Control margin property specifies the size of the whitespace between displayed objects in pixels.
Facility filter	FacilityTagListFilter	Use the Facility filter property to limit the data presented in the control to any CygNet filter 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.
Facility mode	FacilityMode	The Facility mode property specifies how to handle facilities provided to the object container. Options include: Facility list — The object container will use the facilities provided and make an object for each one. Resolve children — The object container will use the Facility filter to resolve the children of the provided facility and create an object for each one. The default value is Resolve children.
Object file path	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 to access either the: Select File dialog box — To access a CygNet APPS or BSS folder Open File dialog box — To access a local or network Windows file-system folder
Object file source	FileSource	This property specifies the source to the file, image, object file, or screen. Options include: BSS — Indicates that the file is stored in a CygNet APPS or BSS folder Local — Indicates that the file is stored in a local or network Windows file-system folder The default file source is Local.
Object limit	ObjectLimit ObjectLimitExceeded ObjectLimitExceededMessage NestedViews NestedViews.Capacity NestedViews.Count	The Object limit property specifies the maximum number of objects to be added to the container. Use this value to limit the number of objects and avoid poor performance when loading an unexpectedly large number of objects.
Resolve filter if no facility	ResolveFilterIfNoFacility	The Resolve filter if no facility property indicates whether to use the facility filter to resolve against all facilities if no facility is provided. If a facility is set for the object container, then it will search the child facilities of that facility using the provided facility filter. By enabling Resolve filter if no facility, the object container will use the provided facility filter against all facilities for the specified SiteService.
CygNet connection	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 to reveal a drop-down area where you can configure the Selection mode, source SiteService, and source Facility. Each option is described below.
CygNet connection: Selection mode	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: 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. On the sending control configure the Facility sender mode property to send facility tag information to another control on the same screen. 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. On the receiving control configure a display tag that associates to a facility property, e.g. %FacilityTag%.
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 GetCygNetFacilitySenders GetCygNetFacilitySenders.Method GetCygNetFacilitySenders.Target GetParentLinkAttribute GetParentLinkAttribute.Method GetParentLinkAttribute.Target GetRelativeFacilityLinks GetRelativeFacilityLinks.Method GetRelativeFacilityLinksTarget IsRelativeFacilityResolutionEnabled RelativeFacilitiesEnabled RelativeFacilitiesEnabled.Method RelativeFacilitiesEnabled.Target RelativeFacilityLinks RelativeFacilityLinks.Capacity RelativeFacilityLinks.Count ResolveRelativeFacilityTag	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 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. 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. 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.
CygNet connection: SiteService	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 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.
String	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.
Yes/No	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.

UI Property

Script Property

Description

Name Type Style

Name

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.

Type

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.

Style

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.

Click to reveal a drop-down menu of predetermined styles configured for the selected control.
Select a desired style and its properties will be applied to the control.
Alternately, you can create a new style based on other property values configured for the control.
Or you can select <None> to remove subscription to any style.

Styles are created in two ways:

In the control's Properties pane. Click (Add a new style based on this control) next to the Style property, after you have configured property values in the Properties pane. See Add a new style based on a control for more information.
In the Canvas Settings in the Backstage view. The default style for any control is configured in the Backstage view. See Manage style sheets in the Backstage view for more information.

Tip: You can also change a control's Style on the Controls view of the Screen pane.

Location

Height

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 Settings icon (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.

Horizontal resize mode

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:

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.

Layer

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.

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.

Tip: You can also edit a control's Layer on the Controls view of the Screen pane.

Note: Layer visibility can be controlled at runtime via the AddLayer, HideLayer, and ShowLayer methods on the Screen object.

Vertical resize mode

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:

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.

Visible

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

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 Settings icon (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.

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 Settings icon (Settings) to the right of the control in design mode.

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 Settings icon (Settings) to the right of the control in design mode.

Z index

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 Settings icon (Settings) to the right of the control in design mode) or on the Controls view of the Screen pane.

Script

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

Object Container

Background color

BackgroundColor

The Background color property specifies the background color of the screen, object, or control. Click Down arrow to select a color using the color picker.

Control margin

ControlMargin

The Control margin property specifies the size of the whitespace between displayed objects in pixels.

Facility filter

FacilityTagListFilter

Use the Facility filter property to limit the data presented in the control to any CygNet filter attribute set up for your CygNet installation. Click Open dialog box 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.

Facility mode

FacilityMode

The Facility mode property specifies how to handle facilities provided to the object container. Options include:

Facility list — The object container will use the facilities provided and make an object for each one.
Resolve children — The object container will use the Facility filter to resolve the children of the provided facility and create an object for each one.

The default value is Resolve children.

Object file path

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 Open dialog box to access either the:

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

Object file source

FileSource

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

BSS — Indicates that the file is stored in a CygNet APPS or BSS folder
Local — Indicates that the file is stored in a local or network Windows file-system folder

The default file source is Local.

Object limit

ObjectLimit

ObjectLimitExceeded

ObjectLimitExceededMessage

NestedViews

NestedViews.Capacity

NestedViews.Count

The Object limit property specifies the maximum number of objects to be added to the container. Use this value to limit the number of objects and avoid poor performance when loading an unexpectedly large number of objects.

Resolve filter if no facility

ResolveFilterIfNoFacility

The Resolve filter if no facility property indicates whether to use the facility filter to resolve against all facilities if no facility is provided. If a facility is set for the object container, then it will search the child facilities of that facility using the provided facility filter. By enabling Resolve filter if no facility, the object container will use the provided facility filter against all facilities for the specified SiteService.

CygNet

CygNet connection

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 Down arrow to reveal a drop-down area where you can configure the Selection mode, source SiteService, and source Facility. Each option is described below.

CygNet connection: Selection mode

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:

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.

On the sending control configure the Facility sender mode property to send facility tag information to another control on the same screen.
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.
On the receiving control configure a display tag that associates to a facility property, e.g. %FacilityTag%.

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

GetCygNetFacilitySenders

GetCygNetFacilitySenders.Method

GetCygNetFacilitySenders.Target

GetParentLinkAttribute

GetParentLinkAttribute.Method

GetParentLinkAttribute.Target

GetRelativeFacilityLinks

GetRelativeFacilityLinks.Method

GetRelativeFacilityLinksTarget

IsRelativeFacilityResolutionEnabled

RelativeFacilitiesEnabled

RelativeFacilitiesEnabled.Method

RelativeFacilitiesEnabled.Target

RelativeFacilityLinks

RelativeFacilityLinks.Capacity

RelativeFacilityLinks.Count

ResolveRelativeFacilityTag

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

CygNet connection: SiteService

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

Generic

String

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.

Yes/No

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.