Open topic with navigation

TIBCO Business Studio™ - BPM Edition 5.4.0

# Members for Control Class

The table lists the members for the Control class.

Control Class

Property | Return Value | Description | Read Only
--- | --- | --- | ---
    className
| String | Returns custom CSS classnames set on the control. The value might be `null`, a single CSS classname, or a space-separated list of CSS classnames that are applied to the root level of the form. The value replaces any previously set classname. |
    controlType
| String | Returns the control type of this control (for example,`com.tibco.forms.controls.textbox`). | Y
    customComponentName
| String | Returns the fully-qualified control type name as defined in the component library for the given control. If the control is not a custom control, the method returns null. | Y
    enabled
| Boolean | Retrieves the enabled flag for this control. |
    form
| Form | Returns the form to which this control belongs. | Y
    hint
| String | Retrieves the hint for this control. |
    label
| String | Retrieves the label for this control. |
    link
| String | Returns the URL used by a hyperlink control. |
    linkText
| String | Returns the visible text rendered by a hyperlink control. |
    optionLabels
| String[] | Returns an array of choice labels displayed by a radiogroup or optionlist control. |
    optionValues
| String[] | Returns an array of choice values offered by a radiogroup or optionlist control. |
    name
| String | Returns the name of this control. | Y
    parent
| Pane | Returns the parent pane object to which this control belongs. | Y
    readOnly
| Boolean | Returns the read-only state of this control. |
    reallyEnabled
| Boolean | The enabled setting of a control is controlled both by its own enabled property, and the enabled properties of any of its ancestors. If the parent pane of a control is disabled, then `reallyEnabled` returns`false` for that control. The method returns `true` only if its own enabled property is `true` and all of its ancestor's enabled properties are set to `true`. | Y
    reallyReadOnly
| Boolean | The readOnly setting of a control is controlled both by its own readOnly property, and the readOnly properties of any of its ancestors. If the parent pane of a control is not read only, then `reallyReadOnly` returns `false` for that control. The method returns `true` every time its own readOnly property is true or any of its ancestor's readOnly property is `true`. | Y
    reallyVisible
| Boolean | The visibility of a control is controlled both by its own visibility property, and the visibility properties of any of its ancestors. If the parent pane of a control is not visible, then `reallyVisible` returns `false` for that control. The method returns `true` only if its own visibility property is `true` and all of its ancestor's visibility properties are set to `true`. | Y
    required
| Boolean | Retrieves or sets the required flag for this control. |
    tabIndex
| Number | Returns the tab index setting configured on the control, or `0` if it is not set. This is useful for custom controls that support the setting of the tab index in their HTML markup. | Y
    url
| String | Returns the URL used by an image control. |
    value
| Object | Retrieves the value of this control. This is a native JavaScript Boolean, Date, String or Number value depending on the control type. Controls configured for list editing or multi-select drop-down lists return an array of the underlying control value type. Date, Time, and DateTime controls return a Date object. check box controls return a Boolean. Numeric text input controls return a Number. All others return String. |
    visible
| Boolean | Retrieves the visible flag for this control. |

Method | Return Value | Description
--- | --- | ---
    setFocus()
| Void | Sets focus on this control.
    setFocus(Integer)
| Void | Sets focus on this control. The API has following optional parameter: `index`: Use this parameter for controls within a grid or record pane. Sets the focus on a control instance in the row specified by the given `index`. If the specified row is not visible, scrolls the grid control to the specified row and page. If the specified row does not exist, logs a warning message and does not shift the focus. This parameter is ignored if the control is in a singleton pane (for instance vertical pane, horizontal pane, and so on). The default value is `0.`
    setFocus(Integer index, Integer item)
| Void | Sets focus on the control. The API has following two optional parameters: `index`: Use this parameter for controls within a grid or record pane. Sets the focus on a control instance in the row specified by the given `index`. If the specified row is not visible, scrolls the grid control to the specified row and page. If the specified row does not exist, logs a warning message and does not shift the focus. This parameter is ignored if the control is in a singleton pane (for instance vertical pane, horizontal pane, and so on). The default value is `0.` `item`: Is used for list controls and specifies the item within the list that is to receive the focus. If the specified item does not exist, logs a warning message and does not shift the focus. This parameter is ignored if the control is not a list control. The default value is `0.` The optional parameters need not be specified for controls that are in a singleton pane (for instance vertical pane, horizontal pane, and so on). For a tabbed pane, you need to activate the particular tab (See `setActiveTab()` API on pane) before calling this API on a control within the corresponding child pane.
    setOptions(String[] values, String[] labels)
| Void | Sets the choice values and labels used by a radiogroup or optionlist control. The values and labels arrays must have the same length. The values array must not contain any null elements.
    validate(Boolean updateMessagePane)
| Boolean | Forces validation to run on the control. Returns `true` if all validations for the control return true. If `updateMessagePane` is `true`, then validation messages are displayed in the messages pane for any validation that failed. If the control is not visible, the validation runs, but `updateMessagePane` is ignored. If `updateMessagePane` is not specified, it is treated as `false`.

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO Business Studio™ - BPM Edition

Copyright © 2015-2023. Cloud Software Group, Inc. All Rights Reserved.