FieldControl
FieldControl Functions
| getCalendarProperties | FieldControl.getCalendarProperties( ) | Properties for the date calendar image. |
| isDisplayEditor | FieldControl.isDisplayEditor( ) | Returns true if the editor part of the field should be displayed, otherwise returns false; |
| setDisplayEditor | FieldControl.setDisplayEditor( displayEditor ) | Sets whether or not the editor part of the field should be displayed; |
| isDisplayInfoText | FieldControl.isDisplayInfoText( ) | Returns true if the help part of the field should be displayed, otherwise returns false; |
| setDisplayInfoText | FieldControl.setDisplayInfoText( displayInfoText ) | Sets whether or not the help part of the field should be displayed; |
| isDisplayLabelText | FieldControl.isDisplayLabelText( ) | Returns true if the label part of the field should be displayed, otherwise returns false; |
| setDisplayLabelText | FieldControl.setDisplayLabelText( displayLabelText ) | Sets whether or not the label part of the field should be displayed; |
| isEditableRadioOrCheckboxList | FieldControl.isEditableRadioOrCheckboxList( ) | Returns true if the field represents a list that will be displayed as a list of radio buttons or checkboxes. |
| getEditorCellClass | FieldControl.getEditorCellClass( ) | Returns the list of CSS classes applied to the <div> tag that wraps the editor. |
| setEditorCellClass | FieldControl.setEditorCellClass( editorCellClass ) | Sets one or more CSS classes to be applied to the <div> tag that wraps the editor. |
| getEditorCellStyle | FieldControl.getEditorCellStyle( ) | Returns the inline CSS style applied to the <div> tag that wraps the editor. |
| setEditorCellStyle | FieldControl.setEditorCellStyle( editorCellStyle ) | Sets the inline CSS style to be applied to the <div> tag that wraps the editor. |
| getEditorClass | FieldControl.getEditorClass( ) | Returns the list of CSS classes applied to the <input> tag when the control is not display only. |
| setEditorClass | FieldControl.setEditorClass( editorClass ) | Sets one or more CSS classes to be applied to the <input> tag when the control is not display only. |
| getEditorInputProperties | FieldControl.getEditorInputProperties( ) | Properties applied to the editor part of the field. |
| getEditorStyle | FieldControl.getEditorStyle( ) | Returns the inline CSS style applied to the <input> tag when the control is not display only. |
| setEditorStyle | FieldControl.setEditorStyle( editorStyle ) | Sets the inline CSS style to be applied to the <input> tag when the control is not display only. |
| getField | FieldControl.getField( ) | Returns the com.ebasetech.xi.api.WebFormField displayed by this Field Control. |
| getFieldClass | FieldControl.getFieldClass( ) | Returns the list of CSS classes applied to the <div> tag that wraps all parts of the field. |
| setFieldClass | FieldControl.setFieldClass( fieldClass ) | Sets one or more CSS classes to be applied to the <div> tag that wraps all parts of the field. |
| getFieldStyle | FieldControl.getFieldStyle( ) | Returns the inline CSS style applied to the <div> tag that wraps all parts of the field. |
| setFieldStyle | FieldControl.setFieldStyle( fieldStyle ) | Sets the inline CSS style to be applied to the <div> tag that wraps all parts of the field. |
| getGapAfterEditor | FieldControl.getGapAfterEditor( ) | The gap after the field editor. |
| setGapAfterEditor | FieldControl.setGapAfterEditor( gapAfterEditor ) | Sets the gap after the field editor. |
| getGapAfterLabel | FieldControl.getGapAfterLabel( ) | The gap after the field label. |
| setGapAfterLabel | FieldControl.setGapAfterLabel( gapAfterLabel ) | Sets the gap after the field label. |
| getGapBeforeInfo | FieldControl.getGapBeforeInfo( ) | The gap before the field help. |
| setGapBeforeInfo | FieldControl.setGapBeforeInfo( gapBeforeInfo ) | Sets the gap before the field help. |
| getHelpButImage | FieldControl.getHelpButImage( ) | Returns the URL of the clickable image used to display the help text in a popup window. |
| setHelpButImage | FieldControl.setHelpButImage( helpButImage ) | Sets the URL of the clickable image used to display the help text in a popup window. |
| getHelpClass | FieldControl.getHelpClass( ) | Returns the list of CSS classes applied to the help text. |
| setHelpClass | FieldControl.setHelpClass( helpClass ) | Sets one or more CSS classes to be applied to help text. |
| getHelpPos | FieldControl.getHelpPos( ) | Returns the position of the help text. |
| setHelpPos | FieldControl.setHelpPos( helpPos ) | Sets the position of the help text. |
| getHelpStyle | FieldControl.getHelpStyle( ) | Returns the inline CSS style applied to the help text. |
| setHelpStyle | FieldControl.setHelpStyle( helpStyle ) | Sets the inline CSS style to be applied to the help text. |
| getHelpWindowProperties | FieldControl.getHelpWindowProperties( ) | Returns the properties passed to the Javascript window.open() statement used to create the popup window, overriding any properties configured using #getInfoProperties(). |
| setHelpWindowProperties | FieldControl.setHelpWindowProperties( helpWindowProperties ) | Sets the properties passed to the Javascript window.open() statement used to create the popup window, overriding any properties configured using #getInfoProperties(). |
| getInfoHtmlElementProperties | FieldControl.getInfoHtmlElementProperties( ) | Return the field info com.ebasetech.xi.api.controls.HtmlElementProperties for the Field Control |
| getInfoProperties | FieldControl.getInfoProperties( ) | Text properties for the label text. |
| getLabelClass | FieldControl.getLabelClass( ) | Returns the list of CSS classes applied to the <div> tag that wraps the label text. |
| setLabelClass | FieldControl.setLabelClass( labelClass ) | Sets one or more CSS classes to be applied to the <div> tag that wraps the label text. |
| getLabelElementClass | FieldControl.getLabelElementClass( ) | Returns the list of CSS classes applied to the <label> tag that contains the label text. |
| setLabelElementClass | FieldControl.setLabelElementClass( labelElementClass ) | Sets one or more CSS classes to be applied to the <label> tag that contains the label text. |
| getLabelElementStyle | FieldControl.getLabelElementStyle( ) | Returns the inline CSS style applied to the <label> tag that contains the label text. |
| setLabelElementStyle | FieldControl.setLabelElementStyle( labelElementStyle ) | Sets the inline CSS style to be applied to the <label> tag that contains the label text. |
| getLabelHtmlElementProperties | FieldControl.getLabelHtmlElementProperties( ) | Return the field label com.ebasetech.xi.api.controls.HtmlElementProperties for the Field Control |
| getLabelProperties | FieldControl.getLabelProperties( ) | Text properties for the label text. |
| getLabelStyle | FieldControl.getLabelStyle( ) | Returns the inline CSS style applied to the <div> tag that wraps the label text. |
| setLabelStyle | FieldControl.setLabelStyle( labelStyle ) | Sets the inline CSS style to be applied to the <div> tag that wraps the label text. |
| getPatternTextClass | FieldControl.getPatternTextClass( ) | Returns the list of CSS classes applied to the value pattern. |
| setPatternTextClass | FieldControl.setPatternTextClass( patternTextClass ) | Sets one or more CSS classes to be applied to the value pattern. |
| getPatternTextStyle | FieldControl.getPatternTextStyle( ) | Returns the inline CSS style applied to the value pattern. |
| setPatternTextStyle | FieldControl.setPatternTextStyle( patternTextStyle ) | Sets the inline CSS style to be applied to the value pattern. |
| getPopupHelpStyle | FieldControl.getPopupHelpStyle( ) | Returns the inline CSS style applied to the popup help window. |
| setPopupHelpStyle | FieldControl.setPopupHelpStyle( popupHelpStyle ) | Sets the inline CSS style applied to the popup help window. |
| getVAlign | FieldControl.getVAlign( ) | Vertical alignment for the entire field including all its parts. |
| setVAlign | FieldControl.setVAlign( vAlign ) | Sets the vertical alignment for the entire field including all its parts. |
| getValuePatternProperties | FieldControl.getValuePatternProperties( ) | Text properties for the value pattern text text. |
BackgroundStyleProperties Functions
| getBackgroundColor | FieldControl.getBackgroundColor( ) | Background color. |
| setBackgroundColor | FieldControl.setBackgroundColor( backgroundColor ) | Sets the background color, this is equivalent to the CSS background-color property and any valid value for this CSS property can be used. |
| getBackgroundImage | FieldControl.getBackgroundImage( ) | URL of the background image. |
| setBackgroundImage | FieldControl.setBackgroundImage( backgroundImage ) | Sets the URL of the background image. |
| getBackgroundImagePosition | FieldControl.getBackgroundImagePosition( ) | Background image position. |
| setBackgroundImagePosition | FieldControl.setBackgroundImagePosition( backgroundImagePosition ) | Sets the background image position. |
| getBackgroundImageRepeat | FieldControl.getBackgroundImageRepeat( ) | Background image repeat property. |
| setBackgroundImageRepeat | FieldControl.setBackgroundImageRepeat( backgroundImageRepeat ) | Sets the background image repeat property. |
BorderStyleProperties Functions
| getBorderColor | FieldControl.getBorderColor( ) | Border color applied to all borders. |
| setBorderColor | FieldControl.setBorderColor( borderColor ) | Sets border color. |
| getBorderRadius | FieldControl.getBorderRadius( ) | Border radius. |
| setBorderRadius | FieldControl.setBorderRadius( borderRadius ) | Sets border radius. |
| getBorderStyle | FieldControl.getBorderStyle( ) | Border style applied to all borders. |
| setBorderStyle | FieldControl.setBorderStyle( borderStyle ) | Sets border style. |
| getBorderWidth | FieldControl.getBorderWidth( ) | Border width applied to all four borders. |
| setBorderWidth | FieldControl.setBorderWidth( borderWidth ) | Sets the border width applied to all four borders. |
| getBottomBorderWidth | FieldControl.getBottomBorderWidth( ) | Bottom border width, overriding property borderWidth. |
| setBottomBorderWidth | FieldControl.setBottomBorderWidth( bottomBorderWidth ) | Sets the bottom border width, overriding property borderWidth. |
| getLeftBorderWidth | FieldControl.getLeftBorderWidth( ) | Left border width, overriding property borderWidth. |
| setLeftBorderWidth | FieldControl.setLeftBorderWidth( leftBorderWidth ) | Sets the left border width, overriding property borderWidth. |
| getRightBorderWidth | FieldControl.getRightBorderWidth( ) | Right border width, overriding property borderWidth. |
| setRightBorderWidth | FieldControl.setRightBorderWidth( rightBorderWidth ) | Sets the right border width, overriding property borderWidth. |
| getTopBorderWidth | FieldControl.getTopBorderWidth( ) | Top border width, overriding property borderWidth. |
| setTopBorderWidth | FieldControl.setTopBorderWidth( topBorderWidth ) | Sets the top border width, overriding property borderWidth. |
Control Functions
| addCssClass | FieldControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | FieldControl.getAll( ) | Returns a control object of the same type as the control object on which this method is invoked, that gives access to all occurrences of this control on the page. |
| isContainer | FieldControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | FieldControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | FieldControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | FieldControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | FieldControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | FieldControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | FieldControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | FieldControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | FieldControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | FieldControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | FieldControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | FieldControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | FieldControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | FieldControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | FieldControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | FieldControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | FieldControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | FieldControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | FieldControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | FieldControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | FieldControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | FieldControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | FieldControl.isNewLine( ) | Returns the new line property. |
| setNewLine | FieldControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | FieldControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | FieldControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | FieldControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | FieldControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | FieldControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | FieldControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | FieldControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | FieldControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | FieldControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | FieldControl.isShowing( ) | Returns true if the control will be included in the web page when it's next displayed to the user, otherwise returns false. |
| getStyle | FieldControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | FieldControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | FieldControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | FieldControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | FieldControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | FieldControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
FieldControlProperties Functions
| addAriaCustomAttribute | FieldControl.addAriaCustomAttribute( name , value ) | Add an ARIA custom attribute with a specified name and value. |
| getAriaCustomAttributes | FieldControl.getAriaCustomAttributes( ) | Returns the ARIA custom attributes for the control. |
| setAriaCustomAttributes | FieldControl.setAriaCustomAttributes( ariaCustomAttributes ) | Sets the ARIA custom attributes associated with the control property and overrides the aria custom attributes value. |
| getAriaDescribedBy | FieldControl.getAriaDescribedBy( ) | Returns the ARIA described-by element ID for the control. |
| getAriaLabelledBy | FieldControl.getAriaLabelledBy( ) | Returns the ARIA labelled-by element ID for the control. |
| getAriaLabelText | FieldControl.getAriaLabelText( ) | Returns the com.ebasetech.xi.api.Text object for the aria label text. |
| isAriaRequired | FieldControl.isAriaRequired( ) | Indicates whether or not this is an aria required field. |
| setAriaRequired | FieldControl.setAriaRequired( ariaRequired ) | Sets whether or not this the aria-required attribute is set to true. |
| isButtonDisplayAsImage | FieldControl.isButtonDisplayAsImage( ) | Indicates whether or not the image specified in the buttonImageUrl property is displayed instead of a button. |
| setButtonDisplayAsImage | FieldControl.setButtonDisplayAsImage( buttonDisplayAsImage ) | Sets whether or not the image specified in the buttonImageUrl property is displayed instead of a button. |
| getButtonImageUrl | FieldControl.getButtonImageUrl( ) | Returns the URL of the image to be displayed when the buttonDisplayAsImage is set to true. |
| setButtonImageUrl | FieldControl.setButtonImageUrl( buttonImageUrl ) | Sets the URL of the image to be displayed when the buttonDisplayAsImage is set to true. |
| isButtonSkipValidation | FieldControl.isButtonSkipValidation( ) | Returns whether or not validation of controls higher on the page is skipped prior to executing the button's on click event. |
| setButtonSkipValidation | FieldControl.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 | FieldControl.getButtonText( ) | Returns the com.ebasetech.xi.api.Text object for the button text. |
| isDisabled | FieldControl.isDisabled( ) | Returns true if the field is marked as disabled, otherwise returns false. |
| setDisabled | FieldControl.setDisabled( disabled ) | Disables the field and results in the HTML disabled attribute being added to the <input> HTML tag. |
| isDisplayIvAsImage | FieldControl.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 | FieldControl.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 | FieldControl.getEditorHtmlElementProperties( ) | Return the field editor com.ebasetech.xi.api.controls.HtmlElementProperties of the control |
| isHyperlink | FieldControl.isHyperlink( ) | Indicates whether or not the field's value should be displayed as a hyperlink. |
| setHyperlink | FieldControl.setHyperlink( hyperlink ) | Sets whether or not the field's value should be displayed as a hyperlink. |
| getHyperlinkProperties | FieldControl.getHyperlinkProperties( ) | Hyperlink properties that apply when the field value should be displayed as a hyperlink
(property hyperlink is set to true). |
| isImmediateValidation | FieldControl.isImmediateValidation( ) | Indicates whether or not control should pass immediately to the Ebase Server when the user changes the field's value. |
| setImmediateValidation | FieldControl.setImmediateValidation( immediateValidation ) | Sets whether or not control should pass immediately to the Ebase Server when the user changes the field's value. |
| getIvImageURL | FieldControl.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 | FieldControl.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 | FieldControl.isMandatory( ) | |
| setMandatory | FieldControl.setMandatory( mandatory ) | |
| getPlaceHolderText | FieldControl.getPlaceHolderText( ) | Returns the com.ebasetech.xi.api.Text object for the place holder text. |
| removeAriaCustomAttribute | FieldControl.removeAriaCustomAttribute( name ) | Remove an ARIA custom attribute specified by name. |
| isRequired | FieldControl.isRequired( ) | Indicates whether or not this is a required field. |
| setRequired | FieldControl.setRequired( required ) | Sets whether or not this is a required field. |
| getRequiredText | FieldControl.getRequiredText( ) | Returns the required message com.ebasetech.xi.api.Text displayed when the field is missing. |
| getValidationText | FieldControl.getValidationText( ) | Returns the HTML5 validation message com.ebasetech.xi.api.Text. |
MarginStyleProperties Functions
| getAllMargin | FieldControl.getAllMargin( ) | Single MarginStyleProperties size value used for top, bottom, left and right margin. |
| setAllMargin | FieldControl.setAllMargin( allMargin ) | Sets the MarginStyleProperties size value used for top, bottom, left and right margin. |
| getBottomMargin | FieldControl.getBottomMargin( ) | Bottom MarginStyleProperties size value. |
| setBottomMargin | FieldControl.setBottomMargin( bottomMargin ) | Sets the bottom MarginStyleProperties size value. |
| getLeftMargin | FieldControl.getLeftMargin( ) | Left MarginStyleProperties size value. |
| setLeftMargin | FieldControl.setLeftMargin( leftMargin ) | Sets the left MarginStyleProperties size value. |
| getRightMargin | FieldControl.getRightMargin( ) | Right MarginStyleProperties size value. |
| setRightMargin | FieldControl.setRightMargin( rightMargin ) | Sets the right MarginStyleProperties size value. |
| getTopMargin | FieldControl.getTopMargin( ) | Top MarginStyleProperties size value. |
| setTopMargin | FieldControl.setTopMargin( topMargin ) | Sets the top MarginStyleProperties size value. |
MessageProperties Functions
| getErrorMessageStyle | FieldControl.getErrorMessageStyle( ) | Returns the MessageStyleProperties object representing error message styling properties. |
| getInfoMessageStyle | FieldControl.getInfoMessageStyle( ) | Returns the MessageStyleProperties object representing info message styling properties. |
| getWarningMessageStyle | FieldControl.getWarningMessageStyle( ) | Returns the MessageStyleProperties object representing warning message styling properties. |
PaddingStyleProperties Functions
| getAllPadding | FieldControl.getAllPadding( ) | Single PaddingStyleProperties size value used for top, bottom, left and right padding. |
| setAllPadding | FieldControl.setAllPadding( allPadding ) | Sets the PaddingStyleProperties size value used for top, bottom, left and right padding. |
| getBottomPadding | FieldControl.getBottomPadding( ) | Bottom PaddingStyleProperties size value. |
| setBottomPadding | FieldControl.setBottomPadding( bottomPadding ) | Sets the bottom PaddingStyleProperties size value. |
| getLeftPadding | FieldControl.getLeftPadding( ) | Left PaddingStyleProperties size value. |
| setLeftPadding | FieldControl.setLeftPadding( leftPadding ) | Sets the left PaddingStyleProperties size value. |
| getRightPadding | FieldControl.getRightPadding( ) | Right PaddingStyleProperties size value. |
| setRightPadding | FieldControl.setRightPadding( rightPadding ) | Sets the right PaddingStyleProperties size value. |
| getTopPadding | FieldControl.getTopPadding( ) | Top PaddingStyleProperties size value. |
| setTopPadding | FieldControl.setTopPadding( topPadding ) | Sets the top PaddingStyleProperties size value. |
MessageContainer Functions
| addErrorMessage | FieldControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | FieldControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | FieldControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | FieldControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | FieldControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | FieldControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | FieldControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | FieldControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | FieldControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | FieldControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | FieldControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | FieldControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | FieldControl.getElementName( ) | Returns the element name |
| getElementType | FieldControl.getElementType( ) | Returns the element type |
Further documentation.