ButtonControl

ButtonControl is one these types:

ButtonControl
FileUploadControl
InitiateUploadControl

ButtonControlProperties Functions

getButtonText	ButtonControl.getButtonText( )	Returns the com.ebasetech.xi.api.Text object for the button text.
isDisabled	ButtonControl.isDisabled( )	Returns true if the button is marked as disabled, otherwise returns false.
setDisabled	ButtonControl.setDisabled( disabled )	Disables the button and results in the HTML disabled attribute being added to the <button> HTML tag.
getMouseOverText	ButtonControl.getMouseOverText( )	Returns the com.ebasetech.xi.api.Text object for the mouse over text.
isSkipValidation	ButtonControl.isSkipValidation( )	Returns the skip validation flag that indicates whether or not validation of controls higher on the page is skipped prior to executing the button's on click event.
setSkipValidation	ButtonControl.setSkipValidation( skipValidation )	Specifies whether or not validation of controls higher on the page is skipped prior to executing the button's on click event.

Control Functions

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

MessageProperties Functions

getErrorMessageStyle	ButtonControl.getErrorMessageStyle( )	Returns the MessageStyleProperties object representing error message styling properties.
getInfoMessageStyle	ButtonControl.getInfoMessageStyle( )	Returns the MessageStyleProperties object representing info message styling properties.
getWarningMessageStyle	ButtonControl.getWarningMessageStyle( )	Returns the MessageStyleProperties object representing warning message styling properties.

BackgroundStyleProperties Functions

getBackgroundColor	ButtonControl.getBackgroundColor( )	Background color.
setBackgroundColor	ButtonControl.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	ButtonControl.getBackgroundImage( )	URL of the background image.
setBackgroundImage	ButtonControl.setBackgroundImage( backgroundImage )	Sets the URL of the background image.
getBackgroundImagePosition	ButtonControl.getBackgroundImagePosition( )	Background image position.
setBackgroundImagePosition	ButtonControl.setBackgroundImagePosition( backgroundImagePosition )	Sets the background image position.
getBackgroundImageRepeat	ButtonControl.getBackgroundImageRepeat( )	Background image repeat property.
setBackgroundImageRepeat	ButtonControl.setBackgroundImageRepeat( backgroundImageRepeat )	Sets the background image repeat property.

BootstrapButtonStyle Functions

getBootstrapSize	ButtonControl.getBootstrapSize( )	The current bootstrap size
setBootstrapSize	ButtonControl.setBootstrapSize( alignment )	Sets the bootstrap size.
getBootstrapState	ButtonControl.getBootstrapState( )	The current bootstrap state
setBootstrapState	ButtonControl.setBootstrapState( alignment )	Sets the bootstrap state.
getBootstrapStyle	ButtonControl.getBootstrapStyle( )	The current bootstrap style
setBootstrapStyle	ButtonControl.setBootstrapStyle( alignment )	Sets the bootstrap style.

BorderStyleProperties Functions

getBorderColor	ButtonControl.getBorderColor( )	Border color applied to all borders.
setBorderColor	ButtonControl.setBorderColor( borderColor )	Sets border color.
getBorderRadius	ButtonControl.getBorderRadius( )	Border radius.
setBorderRadius	ButtonControl.setBorderRadius( borderRadius )	Sets border radius.
getBorderStyle	ButtonControl.getBorderStyle( )	Border style applied to all borders.
setBorderStyle	ButtonControl.setBorderStyle( borderStyle )	Sets border style.
getBorderWidth	ButtonControl.getBorderWidth( )	Border width applied to all four borders.
setBorderWidth	ButtonControl.setBorderWidth( borderWidth )	Sets the border width applied to all four borders.
getBottomBorderWidth	ButtonControl.getBottomBorderWidth( )	Bottom border width, overriding property borderWidth.
setBottomBorderWidth	ButtonControl.setBottomBorderWidth( bottomBorderWidth )	Sets the bottom border width, overriding property borderWidth.
getLeftBorderWidth	ButtonControl.getLeftBorderWidth( )	Left border width, overriding property borderWidth.
setLeftBorderWidth	ButtonControl.setLeftBorderWidth( leftBorderWidth )	Sets the left border width, overriding property borderWidth.
getRightBorderWidth	ButtonControl.getRightBorderWidth( )	Right border width, overriding property borderWidth.
setRightBorderWidth	ButtonControl.setRightBorderWidth( rightBorderWidth )	Sets the right border width, overriding property borderWidth.
getTopBorderWidth	ButtonControl.getTopBorderWidth( )	Top border width, overriding property borderWidth.
setTopBorderWidth	ButtonControl.setTopBorderWidth( topBorderWidth )	Sets the top border width, overriding property borderWidth.

MarginStyleProperties Functions

getAllMargin	ButtonControl.getAllMargin( )	Single MarginStyleProperties size value used for top, bottom, left and right margin.
setAllMargin	ButtonControl.setAllMargin( allMargin )	Sets the MarginStyleProperties size value used for top, bottom, left and right margin.
getBottomMargin	ButtonControl.getBottomMargin( )	Bottom MarginStyleProperties size value.
setBottomMargin	ButtonControl.setBottomMargin( bottomMargin )	Sets the bottom MarginStyleProperties size value.
getLeftMargin	ButtonControl.getLeftMargin( )	Left MarginStyleProperties size value.
setLeftMargin	ButtonControl.setLeftMargin( leftMargin )	Sets the left MarginStyleProperties size value.
getRightMargin	ButtonControl.getRightMargin( )	Right MarginStyleProperties size value.
setRightMargin	ButtonControl.setRightMargin( rightMargin )	Sets the right MarginStyleProperties size value.
getTopMargin	ButtonControl.getTopMargin( )	Top MarginStyleProperties size value.
setTopMargin	ButtonControl.setTopMargin( topMargin )	Sets the top MarginStyleProperties size value.

PaddingStyleProperties Functions

getAllPadding	ButtonControl.getAllPadding( )	Single PaddingStyleProperties size value used for top, bottom, left and right padding.
setAllPadding	ButtonControl.setAllPadding( allPadding )	Sets the PaddingStyleProperties size value used for top, bottom, left and right padding.
getBottomPadding	ButtonControl.getBottomPadding( )	Bottom PaddingStyleProperties size value.
setBottomPadding	ButtonControl.setBottomPadding( bottomPadding )	Sets the bottom PaddingStyleProperties size value.
getLeftPadding	ButtonControl.getLeftPadding( )	Left PaddingStyleProperties size value.
setLeftPadding	ButtonControl.setLeftPadding( leftPadding )	Sets the left PaddingStyleProperties size value.
getRightPadding	ButtonControl.getRightPadding( )	Right PaddingStyleProperties size value.
setRightPadding	ButtonControl.setRightPadding( rightPadding )	Sets the right PaddingStyleProperties size value.
getTopPadding	ButtonControl.getTopPadding( )	Top PaddingStyleProperties size value.
setTopPadding	ButtonControl.setTopPadding( topPadding )	Sets the top PaddingStyleProperties size value.

TextStyleProperties Functions

getLineHeight	ButtonControl.getLineHeight( )	Line height.
setLineHeight	ButtonControl.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	ButtonControl.getTextBold( )	Text bold setting.
setTextBold	ButtonControl.setTextBold( textBold )	Sets the text bold setting.
getTextColor	ButtonControl.getTextColor( )	Text color.
setTextColor	ButtonControl.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	ButtonControl.getTextDecoration( )	Text decoration property (shown as Lines in the designer).
setTextDecoration	ButtonControl.setTextDecoration( textDecoration )	Sets the text decoration property (shown as Lines in the designer).
getTextFont	ButtonControl.getTextFont( )	List of text fonts.
setTextFont	ButtonControl.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	ButtonControl.getTextItalic( )	Text italic setting.
setTextItalic	ButtonControl.setTextItalic( textItalic )	Sets the text italic setting.
getTextSize	ButtonControl.getTextSize( )	Text size.
setTextSize	ButtonControl.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.

MessageContainer Functions

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

Element Functions

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