Verj.io JavaScript API

HTMLControl

An HTML Control can be used to hold any amount of HTML or XHTML content which will be inserted into the output page without amendment; any content that is valid within the BODY section of an HTML page can be inserted. This control is very similar to a Text Control, with the significant difference that multiple languages are not supported.

Further documentation.

HTMLControl Functions

getHtmlText HTMLControl.getHtmlText( ) Returns the com.ebasetech.xi.api.Text object for the text.

Control Functions

addCssClass HTMLControl.addCssClass( cssClass ) Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes.
getAll HTMLControl.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 HTMLControl.isContainer( ) Returns true if this control is a container control i.e.
getCssClass HTMLControl.getCssClass( ) Returns the list of CSS classes configured for the control.
setCssClass HTMLControl.setCssClass( cssClass ) Sets one or more CSS classes to be applied to the control.
isDisplayOnly HTMLControl.isDisplayOnly( ) Returns true if the control is marked as display only, otherwise returns false.
setDisplayOnly HTMLControl.setDisplayOnly( displayOnly ) Marks the control and all its children as display only (when displayOnly is true) or enterable (when displayOnly is false).
isDisplayOnlyIncludingParents HTMLControl.isDisplayOnlyIncludingParents( ) Returns true if the control or any of its parents is marked as display only, otherwise returns false.
getErrorMsgClass HTMLControl.getErrorMsgClass( ) Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control.
setErrorMsgClass HTMLControl.setErrorMsgClass( errorMsgClass ) Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control.
getErrorMsgStyle HTMLControl.getErrorMsgStyle( ) Returns the inline CSS style configured for error messages when the messages are displayed locally to the control.
setErrorMsgStyle HTMLControl.setErrorMsgStyle( errorMsgStyle ) Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control.
isEventField HTMLControl.isEventField( ) Returns true if the control is an event field i.e.
hasModifier HTMLControl.hasModifier( modifier ) Returns true if the control has the specified modifier, otherwise returns false.
isHidden HTMLControl.isHidden( ) Returns true if the control is marked as hidden, otherwise returns false.
setHidden HTMLControl.setHidden( hidden ) Hides or shows the control and all its children.
hide HTMLControl.hide( ) Hides the control, this is equivalent to setting property hidden to true.
getInfoMsgClass HTMLControl.getInfoMsgClass( ) Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control.
setInfoMsgClass HTMLControl.setInfoMsgClass( infoMsgClass ) Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control.
getInfoMsgStyle HTMLControl.getInfoMsgStyle( ) Returns the inline CSS style configured for info messages when the messages are displayed locally to the control.
setInfoMsgStyle HTMLControl.setInfoMsgStyle( infoMsgStyle ) Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control.
isInheritMsg HTMLControl.isInheritMsg( ) Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false.
getLayoutCell HTMLControl.getLayoutCell( ) Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control.
isLocalMsg HTMLControl.isLocalMsg( ) Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false.
isNewLine HTMLControl.isNewLine( ) Returns the new line property.
setNewLine HTMLControl.setNewLine( newLine ) Sets or unsets the control's new line property.
getNextSiblingControl HTMLControl.getNextSiblingControl( ) Returns the control that appears after this control within the same parent, or null if no such control exists.
getPage HTMLControl.getPage( ) Returns the com.ebasetech.xi.api.Page where this control is located.
getParentControl HTMLControl.getParentControl( ) Returns this control's parent control or null if no such parent exists.
getPreviousSiblingControl HTMLControl.getPreviousSiblingControl( ) Returns the control that appears before this control within the same parent, or null if no such control exists.
refresh HTMLControl.refresh( ) Refreshes this control in the user's browser when the page is next displayed.
removeCssClass HTMLControl.removeCssClass( cssClass ) Removes one or more CSS classes from the control.
requestFocus HTMLControl.requestFocus( ) Sets the browser focus to the control.
getRootHtmlElementProperties HTMLControl.getRootHtmlElementProperties( ) Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control
show HTMLControl.show( ) Shows the control, this is equivalent to setting property hidden to false.
isShowing HTMLControl.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 HTMLControl.getStyle( ) Returns the inline CSS style configured for the control.
setStyle HTMLControl.setStyle( style ) Sets inline CSS style to be applied to the control.
getWarningMsgClass HTMLControl.getWarningMsgClass( ) Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control.
setWarningMsgClass HTMLControl.setWarningMsgClass( warningMsgClass ) Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control.
getWarningMsgStyle HTMLControl.getWarningMsgStyle( ) Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control.
setWarningMsgStyle HTMLControl.setWarningMsgStyle( warningMsgStyle ) Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control.

MessageContainer Functions

addErrorMessage HTMLControl.addErrorMessage( message [, stopProcessing ] ) Adds an error message that will be displayed to the user.
addErrorMessage HTMLControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) Adds an error message that will be displayed to the user.
addErrorMessageText HTMLControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) Adds an error message that will be displayed to the user, sourced from an existing text.
addInfoMessage HTMLControl.addInfoMessage( message [, stopProcessing ] ) Adds an information message that will be displayed to the user.
addInfoMessageText HTMLControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) Adds an info message that will be displayed to the user, sourced from an existing text.
addWarningMessage HTMLControl.addWarningMessage( message [, stopProcessing ] ) Adds a warning message that will be displayed to the user.
addWarningMessage HTMLControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) Adds a warning message that will be displayed to the user.
addWarningMessageText HTMLControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) Adds a warning message that will be displayed to the user, sourced from an existing text.
existErrorMessages HTMLControl.existErrorMessages( ) Returns true if undisplayed error messages exist for this element, otherwise returns false.
existInfoMessages HTMLControl.existInfoMessages( ) Returns true if undisplayed info messages exist for this element, otherwise returns false.
existMessages HTMLControl.existMessages( ) Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false.
existWarningMessages HTMLControl.existWarningMessages( ) Returns true if undisplayed warning messages exist for this element, otherwise returns false.

Element Functions

getElementName HTMLControl.getElementName( ) Returns the element name
getElementType HTMLControl.getElementType( ) Returns the element type