BootstrapContainerControl
BasicBlockControl Functions
| getHeight | BootstrapContainerControl.getHeight( ) | Panel height. |
| setHeight | BootstrapContainerControl.setHeight( height ) | Sets the panel height, and is equivalent to the CSS height property and any valid value for this CSS property can be used. |
| getWidth | BootstrapContainerControl.getWidth( ) | Panel width. |
| setWidth | BootstrapContainerControl.setWidth( width ) | Sets the panel width. |
BootstrapContainerTypeProperties Functions
| getBootstrapContainerType | BootstrapContainerControl.getBootstrapContainerType( ) | Returns the bootstrap root container type which is applied to the root div on the page when a form is running with the bootstrap framework configured. |
| setBootstrapContainerType | BootstrapContainerControl.setBootstrapContainerType( bootstrapContainerType ) | Sets the bootstrap root container type which is applied to the root div on the page when a form is running with the bootstrap framework configured. |
AriaControlProperties Functions
| addAriaCustomAttribute | BootstrapContainerControl.addAriaCustomAttribute( name , value ) | Add an ARIA custom attribute with a specified name and value. |
| getAriaCustomAttributes | BootstrapContainerControl.getAriaCustomAttributes( ) | Returns a comma separated list of the ARIA custom attributes for the control. |
| setAriaCustomAttributes | BootstrapContainerControl.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 | BootstrapContainerControl.getAriaDescribedBy( ) | Returns the ARIA described-by element ID for the control. |
| getAriaLabelledBy | BootstrapContainerControl.getAriaLabelledBy( ) | Returns the ARIA labelled-by element ID for the control. |
| getAriaLabelText | BootstrapContainerControl.getAriaLabelText( ) | Returns the com.ebasetech.xi.api.Text object for the ARIA label text. |
| getAriaRole | BootstrapContainerControl.getAriaRole( ) | Returns the ARIA role for the control. |
| setAriaRole | BootstrapContainerControl.setAriaRole( role ) | Sets the ARIA role for the control. |
| removeAriaCustomAttribute | BootstrapContainerControl.removeAriaCustomAttribute( name ) | Remove an ARIA custom attribute specified by name. |
BackgroundStyleProperties Functions
| getBackgroundColor | BootstrapContainerControl.getBackgroundColor( ) | Background color. |
| setBackgroundColor | BootstrapContainerControl.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 | BootstrapContainerControl.getBackgroundImage( ) | URL of the background image. |
| setBackgroundImage | BootstrapContainerControl.setBackgroundImage( backgroundImage ) | Sets the URL of the background image. |
| getBackgroundImagePosition | BootstrapContainerControl.getBackgroundImagePosition( ) | Background image position. |
| setBackgroundImagePosition | BootstrapContainerControl.setBackgroundImagePosition( backgroundImagePosition ) | Sets the background image position. |
| getBackgroundImageRepeat | BootstrapContainerControl.getBackgroundImageRepeat( ) | Background image repeat property. |
| setBackgroundImageRepeat | BootstrapContainerControl.setBackgroundImageRepeat( backgroundImageRepeat ) | Sets the background image repeat property. |
BorderStyleProperties Functions
| getBorderColor | BootstrapContainerControl.getBorderColor( ) | Border color applied to all borders. |
| setBorderColor | BootstrapContainerControl.setBorderColor( borderColor ) | Sets border color. |
| getBorderRadius | BootstrapContainerControl.getBorderRadius( ) | Border radius. |
| setBorderRadius | BootstrapContainerControl.setBorderRadius( borderRadius ) | Sets border radius. |
| getBorderStyle | BootstrapContainerControl.getBorderStyle( ) | Border style applied to all borders. |
| setBorderStyle | BootstrapContainerControl.setBorderStyle( borderStyle ) | Sets border style. |
| getBorderWidth | BootstrapContainerControl.getBorderWidth( ) | Border width applied to all four borders. |
| setBorderWidth | BootstrapContainerControl.setBorderWidth( borderWidth ) | Sets the border width applied to all four borders. |
| getBottomBorderWidth | BootstrapContainerControl.getBottomBorderWidth( ) | Bottom border width, overriding property borderWidth. |
| setBottomBorderWidth | BootstrapContainerControl.setBottomBorderWidth( bottomBorderWidth ) | Sets the bottom border width, overriding property borderWidth. |
| getLeftBorderWidth | BootstrapContainerControl.getLeftBorderWidth( ) | Left border width, overriding property borderWidth. |
| setLeftBorderWidth | BootstrapContainerControl.setLeftBorderWidth( leftBorderWidth ) | Sets the left border width, overriding property borderWidth. |
| getRightBorderWidth | BootstrapContainerControl.getRightBorderWidth( ) | Right border width, overriding property borderWidth. |
| setRightBorderWidth | BootstrapContainerControl.setRightBorderWidth( rightBorderWidth ) | Sets the right border width, overriding property borderWidth. |
| getTopBorderWidth | BootstrapContainerControl.getTopBorderWidth( ) | Top border width, overriding property borderWidth. |
| setTopBorderWidth | BootstrapContainerControl.setTopBorderWidth( topBorderWidth ) | Sets the top border width, overriding property borderWidth. |
LayoutControl Functions
| getLayout | BootstrapContainerControl.getLayout( ) | Returns the Layout object configured for the container control or null if no layout is configured. |
| getLayoutType | BootstrapContainerControl.getLayoutType( ) | Returns a String representing the layout type for the container. |
MarginStyleProperties Functions
| getAllMargin | BootstrapContainerControl.getAllMargin( ) | Single MarginStyleProperties size value used for top, bottom, left and right margin. |
| setAllMargin | BootstrapContainerControl.setAllMargin( allMargin ) | Sets the MarginStyleProperties size value used for top, bottom, left and right margin. |
| getBottomMargin | BootstrapContainerControl.getBottomMargin( ) | Bottom MarginStyleProperties size value. |
| setBottomMargin | BootstrapContainerControl.setBottomMargin( bottomMargin ) | Sets the bottom MarginStyleProperties size value. |
| getLeftMargin | BootstrapContainerControl.getLeftMargin( ) | Left MarginStyleProperties size value. |
| setLeftMargin | BootstrapContainerControl.setLeftMargin( leftMargin ) | Sets the left MarginStyleProperties size value. |
| getRightMargin | BootstrapContainerControl.getRightMargin( ) | Right MarginStyleProperties size value. |
| setRightMargin | BootstrapContainerControl.setRightMargin( rightMargin ) | Sets the right MarginStyleProperties size value. |
| getTopMargin | BootstrapContainerControl.getTopMargin( ) | Top MarginStyleProperties size value. |
| setTopMargin | BootstrapContainerControl.setTopMargin( topMargin ) | Sets the top MarginStyleProperties size value. |
PaddingStyleProperties Functions
| getAllPadding | BootstrapContainerControl.getAllPadding( ) | Single PaddingStyleProperties size value used for top, bottom, left and right padding. |
| setAllPadding | BootstrapContainerControl.setAllPadding( allPadding ) | Sets the PaddingStyleProperties size value used for top, bottom, left and right padding. |
| getBottomPadding | BootstrapContainerControl.getBottomPadding( ) | Bottom PaddingStyleProperties size value. |
| setBottomPadding | BootstrapContainerControl.setBottomPadding( bottomPadding ) | Sets the bottom PaddingStyleProperties size value. |
| getLeftPadding | BootstrapContainerControl.getLeftPadding( ) | Left PaddingStyleProperties size value. |
| setLeftPadding | BootstrapContainerControl.setLeftPadding( leftPadding ) | Sets the left PaddingStyleProperties size value. |
| getRightPadding | BootstrapContainerControl.getRightPadding( ) | Right PaddingStyleProperties size value. |
| setRightPadding | BootstrapContainerControl.setRightPadding( rightPadding ) | Sets the right PaddingStyleProperties size value. |
| getTopPadding | BootstrapContainerControl.getTopPadding( ) | Top PaddingStyleProperties size value. |
| setTopPadding | BootstrapContainerControl.setTopPadding( topPadding ) | Sets the top PaddingStyleProperties size value. |
TextStyleProperties Functions
| getLineHeight | BootstrapContainerControl.getLineHeight( ) | Line height. |
| setLineHeight | BootstrapContainerControl.setLineHeight( lineHeight ) | Sets the line height, this is equivalent to the CSS line-height property and any valid value for this CSS property can be used. |
| getTextBold | BootstrapContainerControl.getTextBold( ) | Text bold setting. |
| setTextBold | BootstrapContainerControl.setTextBold( textBold ) | Sets the text bold setting. |
| getTextColor | BootstrapContainerControl.getTextColor( ) | Text color. |
| setTextColor | BootstrapContainerControl.setTextColor( textColor ) | Sets the text color, this is equivalent to the CSS color property and any valid value for this CSS property can be used. |
| getTextDecoration | BootstrapContainerControl.getTextDecoration( ) | Text decoration property (shown as Lines in the designer). |
| setTextDecoration | BootstrapContainerControl.setTextDecoration( textDecoration ) | Sets the text decoration property (shown as Lines in the designer). |
| getTextFont | BootstrapContainerControl.getTextFont( ) | List of text fonts. |
| setTextFont | BootstrapContainerControl.setTextFont( textFont ) | Sets the list of text fonts, this is equivalent to the CSS font-family property and any valid value for this CSS property can be used. |
| getTextItalic | BootstrapContainerControl.getTextItalic( ) | Text italic setting. |
| setTextItalic | BootstrapContainerControl.setTextItalic( textItalic ) | Sets the text italic setting. |
| getTextSize | BootstrapContainerControl.getTextSize( ) | Text size. |
| setTextSize | BootstrapContainerControl.setTextSize( textSize ) | Sets the text size, this is equivalent to the CSS font-size property and any valid value for this CSS property can be used. |
ContainerControl Functions
| getChildControls | BootstrapContainerControl.getChildControls( ) | Returns an array of controls that are immediate children of this control. |
MessageProperties Functions
| getErrorMessageStyle | BootstrapContainerControl.getErrorMessageStyle( ) | Returns the MessageStyleProperties object representing error message styling properties. |
| getInfoMessageStyle | BootstrapContainerControl.getInfoMessageStyle( ) | Returns the MessageStyleProperties object representing info message styling properties. |
| getWarningMessageStyle | BootstrapContainerControl.getWarningMessageStyle( ) | Returns the MessageStyleProperties object representing warning message styling properties. |
Control Functions
| addCssClass | BootstrapContainerControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | BootstrapContainerControl.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 | BootstrapContainerControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | BootstrapContainerControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | BootstrapContainerControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | BootstrapContainerControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | BootstrapContainerControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | BootstrapContainerControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | BootstrapContainerControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | BootstrapContainerControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | BootstrapContainerControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | BootstrapContainerControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | BootstrapContainerControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | BootstrapContainerControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | BootstrapContainerControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | BootstrapContainerControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | BootstrapContainerControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | BootstrapContainerControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | BootstrapContainerControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | BootstrapContainerControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | BootstrapContainerControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | BootstrapContainerControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | BootstrapContainerControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | BootstrapContainerControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | BootstrapContainerControl.isNewLine( ) | Returns the new line property. |
| setNewLine | BootstrapContainerControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | BootstrapContainerControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | BootstrapContainerControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | BootstrapContainerControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | BootstrapContainerControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | BootstrapContainerControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | BootstrapContainerControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | BootstrapContainerControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | BootstrapContainerControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | BootstrapContainerControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | BootstrapContainerControl.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 | BootstrapContainerControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | BootstrapContainerControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | BootstrapContainerControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | BootstrapContainerControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | BootstrapContainerControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | BootstrapContainerControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
MessageContainer Functions
| addErrorMessage | BootstrapContainerControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | BootstrapContainerControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | BootstrapContainerControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | BootstrapContainerControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | BootstrapContainerControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | BootstrapContainerControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | BootstrapContainerControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | BootstrapContainerControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | BootstrapContainerControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | BootstrapContainerControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | BootstrapContainerControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | BootstrapContainerControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | BootstrapContainerControl.getElementName( ) | Returns the element name |
| getElementType | BootstrapContainerControl.getElementType( ) | Returns the element type |
A container into which responsive bootstrap child elements can be placed.
Further documentation.