FieldControlProperties
FieldControlProperties is one these types:
FieldControlPropertiesFieldColumnControl
FieldControl
Field Control Properties.
FieldControlProperties Functions
| addAriaCustomAttribute | FieldControlProperties.addAriaCustomAttribute( name , value ) | Add an ARIA custom attribute with a specified name and value. |
| getAriaCustomAttributes | FieldControlProperties.getAriaCustomAttributes( ) | Returns the ARIA custom attributes for the control. |
| setAriaCustomAttributes | FieldControlProperties.setAriaCustomAttributes( ariaCustomAttributes ) | Sets the ARIA custom attributes associated with the control property and overrides the aria custom attributes value. |
| getAriaDescribedBy | FieldControlProperties.getAriaDescribedBy( ) | Returns the ARIA described-by element ID for the control. |
| getAriaLabelledBy | FieldControlProperties.getAriaLabelledBy( ) | Returns the ARIA labelled-by element ID for the control. |
| getAriaLabelText | FieldControlProperties.getAriaLabelText( ) | Returns the com.ebasetech.xi.api.Text object for the aria label text. |
| isAriaRequired | FieldControlProperties.isAriaRequired( ) | Indicates whether or not this is an aria required field. |
| setAriaRequired | FieldControlProperties.setAriaRequired( ariaRequired ) | Sets whether or not this the aria-required attribute is set to true. |
| isButtonDisplayAsImage | FieldControlProperties.isButtonDisplayAsImage( ) | Indicates whether or not the image specified in the buttonImageUrl property is displayed instead of a button. |
| setButtonDisplayAsImage | FieldControlProperties.setButtonDisplayAsImage( buttonDisplayAsImage ) | Sets whether or not the image specified in the buttonImageUrl property is displayed instead of a button. |
| getButtonImageUrl | FieldControlProperties.getButtonImageUrl( ) | Returns the URL of the image to be displayed when the buttonDisplayAsImage is set to true. |
| setButtonImageUrl | FieldControlProperties.setButtonImageUrl( buttonImageUrl ) | Sets the URL of the image to be displayed when the buttonDisplayAsImage is set to true. |
| isButtonSkipValidation | FieldControlProperties.isButtonSkipValidation( ) | Returns whether or not validation of controls higher on the page is skipped prior to executing the button's on click event. |
| setButtonSkipValidation | FieldControlProperties.setButtonSkipValidation( buttonSkipValidation ) | Specifies whether or not validation of controls higher on the page is skipped prior to executing the button's on click event. |
| getButtonText | FieldControlProperties.getButtonText( ) | Returns the com.ebasetech.xi.api.Text object for the button text. |
| isDisabled | FieldControlProperties.isDisabled( ) | Returns true if the field is marked as disabled, otherwise returns false. |
| setDisabled | FieldControlProperties.setDisabled( disabled ) | Disables the field and results in the HTML disabled attribute being added to the <input> HTML tag. |
| isDisplayIvAsImage | FieldControlProperties.isDisplayIvAsImage( ) | Indicates that a button is displayed as an image, and is applicable only when Javascript is disabled and immediate validation is simulated using buttons/images to be clicked by the user. |
| setDisplayIvAsImage | FieldControlProperties.setDisplayIvAsImage( displayIvAsImage ) | Sets whether or not a button is displayed as an image, and is applicable only when Javascript is disabled and immediate validation is simulated using buttons/images to be clicked by the user. |
| getEditorHtmlElementProperties | FieldControlProperties.getEditorHtmlElementProperties( ) | Return the field editor com.ebasetech.xi.api.controls.HtmlElementProperties of the control |
| isHyperlink | FieldControlProperties.isHyperlink( ) | Indicates whether or not the field's value should be displayed as a hyperlink. |
| setHyperlink | FieldControlProperties.setHyperlink( hyperlink ) | Sets whether or not the field's value should be displayed as a hyperlink. |
| getHyperlinkProperties | FieldControlProperties.getHyperlinkProperties( ) | Hyperlink properties that apply when the field value should be displayed as a hyperlink
(property hyperlink is set to true). |
| isImmediateValidation | FieldControlProperties.isImmediateValidation( ) | Indicates whether or not control should pass immediately to the Ebase Server when the user changes the field's value. |
| setImmediateValidation | FieldControlProperties.setImmediateValidation( immediateValidation ) | Sets whether or not control should pass immediately to the Ebase Server when the user changes the field's value. |
| getIvImageURL | FieldControlProperties.getIvImageURL( ) | Returns the URL of the image to be displayed when Javascript is disabled and immediate
validation is simulated using an image to be clicked by the user (displayIvAsImage is set to true). |
| setIvImageURL | FieldControlProperties.setIvImageURL( url ) | Sets the URL of the image to be displayed when Javascript is disabled and immediate
validation is simulated using an image to be clicked by the user
(property displayIvAsImage is set to true). |
| isMandatory | FieldControlProperties.isMandatory( ) | |
| setMandatory | FieldControlProperties.setMandatory( mandatory ) | |
| getPlaceHolderText | FieldControlProperties.getPlaceHolderText( ) | Returns the com.ebasetech.xi.api.Text object for the place holder text. |
| removeAriaCustomAttribute | FieldControlProperties.removeAriaCustomAttribute( name ) | Remove an ARIA custom attribute specified by name. |
| isRequired | FieldControlProperties.isRequired( ) | Indicates whether or not this is a required field. |
| setRequired | FieldControlProperties.setRequired( required ) | Sets whether or not this is a required field. |
| getRequiredText | FieldControlProperties.getRequiredText( ) | Returns the required message com.ebasetech.xi.api.Text displayed when the field is missing. |
| getValidationText | FieldControlProperties.getValidationText( ) | Returns the HTML5 validation message com.ebasetech.xi.api.Text. |