CanvasControl
CanvasControl Functions
| getCanvasHeight | CanvasControl.getCanvasHeight( ) | Canvas height. |
| setCanvasHeight | CanvasControl.setCanvasHeight( imageHeight ) | Sets the canvas height. |
| getCanvasWidth | CanvasControl.getCanvasWidth( ) | Canvas width. |
| setCanvasWidth | CanvasControl.setCanvasWidth( imageWidth ) | Sets the canvas width. |
AriaControlProperties Functions
| addAriaCustomAttribute | CanvasControl.addAriaCustomAttribute( name , value ) | Add an ARIA custom attribute with a specified name and value. |
| getAriaCustomAttributes | CanvasControl.getAriaCustomAttributes( ) | Returns a comma separated list of the ARIA custom attributes for the control. |
| setAriaCustomAttributes | CanvasControl.setAriaCustomAttributes( ariaCustomAttributes ) | Sets the ARIA custom attributes as a comma separated list associated with the control property and overrides the aria custom attributes value. |
| getAriaDescribedBy | CanvasControl.getAriaDescribedBy( ) | Returns the ARIA described-by element ID for the control. |
| getAriaLabelledBy | CanvasControl.getAriaLabelledBy( ) | Returns the ARIA labelled-by element ID for the control. |
| getAriaLabelText | CanvasControl.getAriaLabelText( ) | Returns the com.ebasetech.xi.api.Text object for the ARIA label text. |
| getAriaRole | CanvasControl.getAriaRole( ) | Returns the ARIA role for the control. |
| setAriaRole | CanvasControl.setAriaRole( role ) | Sets the ARIA role for the control. |
| removeAriaCustomAttribute | CanvasControl.removeAriaCustomAttribute( name ) | Remove an ARIA custom attribute specified by name. |
BackgroundStyleProperties Functions
| getBackgroundColor | CanvasControl.getBackgroundColor( ) | Background color. |
| setBackgroundColor | CanvasControl.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 | CanvasControl.getBackgroundImage( ) | URL of the background image. |
| setBackgroundImage | CanvasControl.setBackgroundImage( backgroundImage ) | Sets the URL of the background image. |
| getBackgroundImagePosition | CanvasControl.getBackgroundImagePosition( ) | Background image position. |
| setBackgroundImagePosition | CanvasControl.setBackgroundImagePosition( backgroundImagePosition ) | Sets the background image position. |
| getBackgroundImageRepeat | CanvasControl.getBackgroundImageRepeat( ) | Background image repeat property. |
| setBackgroundImageRepeat | CanvasControl.setBackgroundImageRepeat( backgroundImageRepeat ) | Sets the background image repeat property. |
BorderStyleProperties Functions
| getBorderColor | CanvasControl.getBorderColor( ) | Border color applied to all borders. |
| setBorderColor | CanvasControl.setBorderColor( borderColor ) | Sets border color. |
| getBorderRadius | CanvasControl.getBorderRadius( ) | Border radius. |
| setBorderRadius | CanvasControl.setBorderRadius( borderRadius ) | Sets border radius. |
| getBorderStyle | CanvasControl.getBorderStyle( ) | Border style applied to all borders. |
| setBorderStyle | CanvasControl.setBorderStyle( borderStyle ) | Sets border style. |
| getBorderWidth | CanvasControl.getBorderWidth( ) | Border width applied to all four borders. |
| setBorderWidth | CanvasControl.setBorderWidth( borderWidth ) | Sets the border width applied to all four borders. |
| getBottomBorderWidth | CanvasControl.getBottomBorderWidth( ) | Bottom border width, overriding property borderWidth. |
| setBottomBorderWidth | CanvasControl.setBottomBorderWidth( bottomBorderWidth ) | Sets the bottom border width, overriding property borderWidth. |
| getLeftBorderWidth | CanvasControl.getLeftBorderWidth( ) | Left border width, overriding property borderWidth. |
| setLeftBorderWidth | CanvasControl.setLeftBorderWidth( leftBorderWidth ) | Sets the left border width, overriding property borderWidth. |
| getRightBorderWidth | CanvasControl.getRightBorderWidth( ) | Right border width, overriding property borderWidth. |
| setRightBorderWidth | CanvasControl.setRightBorderWidth( rightBorderWidth ) | Sets the right border width, overriding property borderWidth. |
| getTopBorderWidth | CanvasControl.getTopBorderWidth( ) | Top border width, overriding property borderWidth. |
| setTopBorderWidth | CanvasControl.setTopBorderWidth( topBorderWidth ) | Sets the top border width, overriding property borderWidth. |
Control Functions
| addCssClass | CanvasControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | CanvasControl.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 | CanvasControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | CanvasControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | CanvasControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | CanvasControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | CanvasControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | CanvasControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | CanvasControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | CanvasControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | CanvasControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | CanvasControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | CanvasControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | CanvasControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | CanvasControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | CanvasControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | CanvasControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | CanvasControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | CanvasControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | CanvasControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | CanvasControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | CanvasControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | CanvasControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | CanvasControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | CanvasControl.isNewLine( ) | Returns the new line property. |
| setNewLine | CanvasControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | CanvasControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | CanvasControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | CanvasControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | CanvasControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | CanvasControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | CanvasControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | CanvasControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | CanvasControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | CanvasControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | CanvasControl.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 | CanvasControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | CanvasControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | CanvasControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | CanvasControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | CanvasControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | CanvasControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
MarginStyleProperties Functions
| getAllMargin | CanvasControl.getAllMargin( ) | Single MarginStyleProperties size value used for top, bottom, left and right margin. |
| setAllMargin | CanvasControl.setAllMargin( allMargin ) | Sets the MarginStyleProperties size value used for top, bottom, left and right margin. |
| getBottomMargin | CanvasControl.getBottomMargin( ) | Bottom MarginStyleProperties size value. |
| setBottomMargin | CanvasControl.setBottomMargin( bottomMargin ) | Sets the bottom MarginStyleProperties size value. |
| getLeftMargin | CanvasControl.getLeftMargin( ) | Left MarginStyleProperties size value. |
| setLeftMargin | CanvasControl.setLeftMargin( leftMargin ) | Sets the left MarginStyleProperties size value. |
| getRightMargin | CanvasControl.getRightMargin( ) | Right MarginStyleProperties size value. |
| setRightMargin | CanvasControl.setRightMargin( rightMargin ) | Sets the right MarginStyleProperties size value. |
| getTopMargin | CanvasControl.getTopMargin( ) | Top MarginStyleProperties size value. |
| setTopMargin | CanvasControl.setTopMargin( topMargin ) | Sets the top MarginStyleProperties size value. |
PaddingStyleProperties Functions
| getAllPadding | CanvasControl.getAllPadding( ) | Single PaddingStyleProperties size value used for top, bottom, left and right padding. |
| setAllPadding | CanvasControl.setAllPadding( allPadding ) | Sets the PaddingStyleProperties size value used for top, bottom, left and right padding. |
| getBottomPadding | CanvasControl.getBottomPadding( ) | Bottom PaddingStyleProperties size value. |
| setBottomPadding | CanvasControl.setBottomPadding( bottomPadding ) | Sets the bottom PaddingStyleProperties size value. |
| getLeftPadding | CanvasControl.getLeftPadding( ) | Left PaddingStyleProperties size value. |
| setLeftPadding | CanvasControl.setLeftPadding( leftPadding ) | Sets the left PaddingStyleProperties size value. |
| getRightPadding | CanvasControl.getRightPadding( ) | Right PaddingStyleProperties size value. |
| setRightPadding | CanvasControl.setRightPadding( rightPadding ) | Sets the right PaddingStyleProperties size value. |
| getTopPadding | CanvasControl.getTopPadding( ) | Top PaddingStyleProperties size value. |
| setTopPadding | CanvasControl.setTopPadding( topPadding ) | Sets the top PaddingStyleProperties size value. |
MessageContainer Functions
| addErrorMessage | CanvasControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | CanvasControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | CanvasControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | CanvasControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | CanvasControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | CanvasControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | CanvasControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | CanvasControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | CanvasControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | CanvasControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | CanvasControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | CanvasControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | CanvasControl.getElementName( ) | Returns the element name |
| getElementType | CanvasControl.getElementType( ) | Returns the element type |
Further documentation.