Column Element

Applies to TestComplete 14.72, last modified on December 24, 2020
Description

The Column element of the description.xml file is used to define the operation’s data displayed in a particular column of Keyword Test editor’s Test Steps page. This element also lets you define the type and behavior of the in-place editor used to modify this data. For more information, see Customizing KeywordTest Editor Contents and Implementing In-Place Editing Support.

Parent Elements

A Column element must be a child of the Columns element.

Child Elements

A Column element may contain one or more Event elements.

Attributes

The element has the following attributes:

Name

Required. Specifies the column name. Possible values are: Item, Operation, Value and Description.

Value

Optional. The text to be displayed in the column.

GetValue

Optional. The name of the script routine that returns the text to be displayed in the column. You can use this attribute instead of Value if you need to construct the column text on-the-fly.

Notes:

  • The routine must be implemented in the script file specified in the Name attribute of the Script element.

  • The routine must have one parameter, Data, which is an object providing access to the operation’s fields defined by the Field elements. This object contains properties that correspond to individual operation fields and whose names coincide with the field names.

  • The routine must return a string holding the text to display in the column.

Hint

Optional. The column’s hint text.

GetHint

Optional. The name of the script routine that returns the column’s hint text. You can use this attribute instead of Hint if you need to construct the hint text on-the-fly.

Notes

  • The routine must be implemented in the script file specified in the Name attribute of the Script element.

  • The routine must have one parameter, Data, which is an object providing access to the operation’s fields defined by the Field elements. This object contains properties that correspond to individual operation fields and whose names coincide with the field names.

  • The routine must return a string holding the hint for the column.

Note: If neither Hint, nor GetHint attributes are specified, TestComplete will use a standard hint. That is, the hint will display the cell text in case the text length does not fit the column width.

Editable

Optional. Specifies whether the operation’s data displayed in the corresponding column can be edited. Possible values are True and False. The default is False.

Note: Values in the Item column of the Keyword Test editor are typically read-only.

GetEditable

Optional. The name of the script routine that is used to determine whether the operation’s data displayed in the column can be edited. You can use this attribute instead of Editable if you need to change the cell’s editable state on-the-fly.

Notes:

  • The routine must be implemented in the script file specified in the Name attribute of the Script element.

  • The routine must have one parameter, Data, which is an object providing access to the operation’s fields defined by the Field elements. This object contains properties that correspond to individual operation fields and whose names coincide with the field names.

  • The routine must return a boolean value: True if the value in the column can be edited and False otherwise.

Note: If both Editable and GetEditable attributes are specified, TestComplete uses the GetEditable routine to determine the cell’s editable state. However, if the specified routine was not found or if it returned an incorrect value, the Editable attribute value is used instead.

EditorType

Optional. Specifies the type of the cell’s editor, in case the cell is editable. Possible values are:

  • Text (Default) - A text box, which allows the user to manually enter values. This editor type is typically used for the Description column.
  • Combo - A combo box, which allows the user to choose from one of the pre-defined values. This editor type is typically used for the Operation column.
  • Button - A text box with a number of embedded buttons. The buttons can perform various helper actions, for example, invoke dialogs, reset the cell value to the default one, and so on.
  • Parameters - A read-only text box with the embedded ellipsis button that invokes the Operation Parameters dialog. This editor type is typically used for the Value column.
Remarks

For more information about specifying operation data to be displayed in the Keyword Test editor, see Customizing KeywordTest Editor Contents.

In-place editor raise a number of events that you may wish to handle in your keyword test operation. For more information on this, see Implementing In-Place Editing Support.

See Also

Elements Reference
Structure of the Description File
Creating Keyword Test Operations
Creating Keyword Test Operations Tutorial

Highlight search results