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 allowed. 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 Enabled check box indicates whether the control is enabled. The default value is True. When set to False, the control is visible in run mode, but grayed out and disabled from use.

Use the Facility filter property to limit the data presented in the control to any CygNet facility attribute set up for your CygNet installation. A search will be executed against the facilities that are described by this filter. 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.

The Facility attribute: Primary property specifies the facility attribute that will be displayed as text in the left position of a search result. Click to reveal a drop-down menu of all available facility attributes. Select an attribute from the list. The default attribute is Facility Description.

The Facility attribute: Secondary property specifies the facility attribute that will be displayed as text in the right position of a search result. Click to reveal a drop-down menu of all available facility attributes. Select an attribute from the list. The default attribute is Facility Site.Service.

Use the Properties to Search property to select the facility properties (attributes) that will be searched in the search box. Click to open the Properties to Search dialog box and select the facility attributes to use. Searching many attributes and searching non-indexed attributes may negatively impact performance. The default attributes are Facility Description and Facility ID.

The Search custom check box indicates whether a custom search will be performed.

This property invokes the CustomSearch script property, a delegate that references a custom search method, when a user searches for a string.

Example

Copy

private void Search2_Initialize(object sender, EventArgs args)
{
    Objects.Search2.CustomSearch = DoCustomSearch;
    ParseCsvFile(@"C:\Temp\List.csv");
}

See Scripting Custom Searches for more information about this property.

The Search facilities check box indicates whether to search for facilities based on facility attributes, filter settings, and SiteService. The default value is True. This property works in conjunction with the Facility filter, Properties to search, and SiteService properties.

The Selected action property specifies the action to take when a result is selected. Options include:

• FacilitySender — The control acts as a facility sender and sends the selected facility to any controls configured to receive it. This only works if the selected result includes a facility.
• Navigate — The control will navigate to the selected facility's associated screen or the selected screen. The navigation mode is determined by the Facility navigation mode property setting on the screen displaying the control. See Navigation by Facility for more information.
• Script —

  Executes a script event (Search Results Selected) when selecting a facility or custom item from the search results.

  Notes for the Search Box:

  • If you are setting up a facility search, and want to script the selection action, you also need to enable the Search facilities check box.
  • If you are setting up a custom search to query some other object, for example, a SQL database, a .csv file, even a website, you also need to enable the Search custom check box.
  • See Scripting Custom Searches for more information.

The default value is FacilitySender.

The SiteServices property specifies the current value or facility service(s) to search. Resolution will be against all facilities in the provided service's associated facility service. Options include:

• Source — Options include <Self> or Screen.
  • <Self> — Select <Self> to explicitly configure the SiteService for this control or screen element. A SiteService selector is displayed:
    • SiteService — The SiteServices property specifies the service(s) for which the search box is to display data. Click to select a service(s) using the Select Services dialog box.
  • Screen — Select Screen to inherit 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 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.