Appearance

Class

Identifies the Class name to use when applying styles at run-time. Defaults to the control’s element name.

CSSClass

Identifies the CSS Class name to use when applying the styles at run-time. Defaults to the control’s element name.

ImageKey

Allows you to associate an image with the control.

ImageURL

The URI of the command to execute.

Importance

Describes the relative importance of this control in the workflow of the screen. Can be used in conjunction with themes to set the background color of the control. For example, if you have added a number of GroupBox controls you can set their importance at different levels. The color of the group box signifies their importance.

InnerHTML

Allows you to insert HTML content into the control, which is then displayed at run-time.

ParameterRendering

The method by which the parameters are displayed. Can be set to either manual or automatic.

State

Identifies the State attribute of the theme item when applying styles at run-time.

Text

The text associated with the control. What is written in the Text text box is what will appear on the screen unless the Text is being controlled by the API.

TextAlign

Allows you to select where within the control you would like to place the text. For example, Centered, Top Left, etc.

Theme

Allows you to implement a custom theme to the form you are creating. The theme must be saved to the themes folder on your web server.

Tooltip

Allows you to provide additional information to your customers. Any text entered here will display to the user upon mouse-over of the control.

Behavior

ActiveTaskGroup

The task group to expand when the control is active.

AppendKey

If true, the key of the selected item is automatically appended to the command URI specified in the Command property.

AutoSize

Overrides the size of the box you drew for the control and fits it to the control’s size.

CancelSelect

If True, it does not allow a row to be selected. Use for formatted lists where the rows are hyperlinks to other forms or controls.

ClearCommand

The URI of the Clear command.

Command

The URI of the command to execute.

CommandEvent

Determines whether the command entered in the Command property is performed when you either click or double-click the item.

Enabled

Indicates whether the control can respond to user interaction.

MaxBandDepth

Determines the maximum amount of bands visible in a grid.

NavigateURL

For the Hyperlink control, this is where you would define the URL to which you want the user to be directed.

Postback

Used only in the Web Form Designer, this property determines when the system postsback to the API object. There are three settings available for this control:

·       Auto – This selection postsback to the API upon tab-out. When this is selected, each time the user tabs-out of the control their is a wait that occurs as the system postsback to the API. Unbound controls do not postback.

·       Always – This selection is the exact same as Auto, with the exception that unbound controls also postback.

·       Deferred – This selection defers the postback to the API until the “Save” button is clicked. This means that there is no wait that occurs when the user tabs-out of a control.

The Postback property is only available for the following controls:

·       CheckBox

·       ComboBox

·       DatePicker

·       Textbox

TabIndex

Determines the index in the tab order this control will occupy.

TabStop

Indicates whether the user can use the tab key to set focus on the control.

Taskbar

Opens the Task Bar Designer.

Titlebar

Allows you to set the titlebar properties.

Visible

Indicates whether or not the control will display on the screen.

Data

BindingContext

Defines a new data binding context, relative to the parent control’s context, for the control’s children.

BindingsCollectionType

The collection of data bindings for this control. Requires familiarity with Code Behind.

PropertyName

The API property reference for this control. Used to identify search parameters or wizard property names.

TargetCollection

Defines which collection will be used to return the desired search results.

Design

Name

The name of the control.

Help

Description

The description of the control to be displayed as the control’s tool tip.

HelpTopicID

Identifies the ID of the topic to display when Online Help is rendered.

Layout

Anchor

Sets which edges of the control are anchored to which edge of its container.

Autofit

This functionality allows Search Results Grids to expand further in order to include more room for columns by maintaining the grid size and adding the horizontal scrollbars.

Dock

Identifies the edge of the form to which the control is attached.

LayoutManager

Provides automatic layout for controls contained within another container.

Location (X,Y)

Coordinates of the upper-left corner of the control relative to the upper-left corner of its container. Applies only when the container’s layout mode is “fixed.” For all other layout modes, the Location attribute is ignored.

Size (Width, Height)

The size of the control.

Miscellaneous

AddCheckBoxColumnToResults

Displays checkboxes next to the search results allowing you to select multiple results for review.

AllowSearchExport

Allows you to export your search results. For example, to Excel, Word, etc.

AlwaysShowNewRecords

This property allows you to specify whether new records are shown even if they do not meet search criteria. Prior to the 7.0.7 release, the filter control always showed new records no matter what the filter condition was.

This property defaults to “True.”

AutoSearch

Automatically searches upon opening the screen.

AutoSelectSingleRecord

If only a single record is returned from a search, it is automatically selected.

AutoSize

Set to either True or False. True sets the width of the control (usually a label) to auto-expand based on its content. For example, if the label is bound to LastName, the width of the label will be set to the length of the LastName that appears. False sets the width to the fixed width specified when creating the control. For example, if the label is bound to a very long LastName and the custom width is small, the LastName will continue to ‘run off’ the label, usually being cut off. This field defaults to False. Usually used in conjunction with AutoWrap.

AutoSize (Image control)

Set to either True or False. Setting this to True resizes the Image control to the default size of the selected image. If the selected image is larger than the custom size set for the Image control, it will expand. If the selected image is smaller than the custom size set for the Image control, it will shrink. Setting this to False constrains the selected image to the custom size set for the Image control. For example, if the selected image is larger than the custom size set for the Image control, the image will be shrunk to fit the custom Image control size.

AutoWrap

Set to either True or False. Setting this value to True allows the content of the control to automatically wrap downwards. For example, if the control’s content has a long string of comments, and AutoWrap is set to True, the comments will automatically fill downwards, wrapping to a new line when it hits the right side of the control. Setting this value to False causes a string of comments to continue to ‘run off’ the control, usually cutting off the string. This field defaults to False. Usually used in conjunction with AutoSize.

BackgroundImage

The background image for the picture box.

Bands

Collection of band information for the grid.

BandsVisible

Determines whether or not you want the bands to be visible in the grid.

BindTo

Allows you to choose which API property the control will use.

Buttons

Allows you to add or remove buttons from the data grid.

Columns

A collection of column information for the grid band.

ColumnsVisible

Determines whether or not you can view the column.

Checked

Determines if the checkbox is automatically checked when the screen opens.

EnforceLimits

Determines whether a limit on search results returned will be set or not.

Error Limit

The maximum number of search results allowed to be returned before an error appears.

Expandable

Determines whether the group box is expandable or not.

Expanded

Determines whether the group box is automatically expanded when the screen is called.

Format

Determines the format in which the date will be displayed.

IgnoreContext

Determines whether to filter the search by the context OrgId and OrgUnitId. Applies only if the TargetCollection has the OrganizationId and OrganizationUnitId properties.

Importance

Describes the relative importance of this control in the workflow of the screen. Can be used in conjunction with themes to set the background color of the control. For example, if you have added a number of GroupBox controls, you can set their Importance at different levels. The color of the group box signifies their importance.

Image

The name of the image.

InitializeAction

Determines whether a new object is instantiated automatically if the collection is empty. If no InstantiatingMethod is specified, this adds to the collection using AddNew of the collection to which the control is bound.

InstantiatingMethod

If a method is provided, it will be executed for the instantiation.

MaxValue

The maximum numeric value for the control.

MinValue

The minimum numeric value for the control.

Multiselect

Allows you to select multiple records.

NoResultsText

The message that will display if there are no results for a given search.

Orientation

For the Line tool, determines whether it will be vertical or horizontal.

Pages

Allows you to add or delete pages.

ParameterColumns

Allows you to divide the search parameters into a chosen number of columns.

ParameterCaption

Allows you to name the box containing the search parameters.

QueryPanelHeight

If the ParameterRendering is set to manual, this controls the height of the top query panel.

Read-Only

Does not allow for the changing of the displayed information.

ResultsCaption

Allows you to name the heading above your search results.

ResultsGridHeight

Allows you to set the height of the search grid in pixels. This defaults to 300. A scroll bar is added to the search grid if the number of search results returned exceeds the limit set here. If there is no value set, all search results will display (no scroll bar is inserted).

SearchParametersCollectionType

Allows you to choose, via the API properties, which parameters you would like to use in your search.

ShowHeaders

Determines whether or not the headers will be shown for the list.

SizeMode

Determines how the image will be formatted to its container.

SpellCheck

Setting this parameter to “True” for a control enables the spell checker. Misspelled words are underlined with a red line.

TabPages

Controls the collection for TabControl elements.

Thickness

Determines the thickness of the line.

Type

The type of up/down control. When “Numeric,” the MinValue and MaxValue attributes are used to establish the range of the control.

ValueListElementType

A list of values to populate a list control.

WarningLimit

The maximum amount of results that will be displayed before a warning window appears.

Security

Edit Permission

Specifies the access-point for editing data displayed in this element.

ViewPermission

Specifies the access-point to view this element.

Sorting and Grouping

GroupByEnabled

This functionality allows user to select a column in the Search Results Grid to group all the results in.

MultipleColumnSort

This functionality allows users to sort their search results by more than one column heading. To do so, they need to hold down their SHIFT key and select the columns in the order in which they want their results sorted.