ArticleControl

BasicBlockControl Functions

getHeight	ArticleControl.getHeight( )	Panel height.
setHeight	ArticleControl.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	ArticleControl.getWidth( )	Panel width.
setWidth	ArticleControl.setWidth( width )	Sets the panel width.

AriaControlProperties Functions

addAriaCustomAttribute	ArticleControl.addAriaCustomAttribute( name , value )	Add an ARIA custom attribute with a specified name and value.
getAriaCustomAttributes	ArticleControl.getAriaCustomAttributes( )	Returns a comma separated list of the ARIA custom attributes for the control.
setAriaCustomAttributes	ArticleControl.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	ArticleControl.getAriaDescribedBy( )	Returns the ARIA described-by element ID for the control.
getAriaLabelledBy	ArticleControl.getAriaLabelledBy( )	Returns the ARIA labelled-by element ID for the control.
getAriaLabelText	ArticleControl.getAriaLabelText( )	Returns the com.ebasetech.xi.api.Text object for the ARIA label text.
getAriaRole	ArticleControl.getAriaRole( )	Returns the ARIA role for the control.
setAriaRole	ArticleControl.setAriaRole( role )	Sets the ARIA role for the control.
removeAriaCustomAttribute	ArticleControl.removeAriaCustomAttribute( name )	Remove an ARIA custom attribute specified by name.

BackgroundStyleProperties Functions

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

BorderStyleProperties Functions

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

LayoutControl Functions

getLayout	ArticleControl.getLayout( )	Returns the Layout object configured for the container control or null if no layout is configured.
getLayoutType	ArticleControl.getLayoutType( )	Returns a String representing the layout type for the container.

MarginStyleProperties Functions

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

PaddingStyleProperties Functions

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

TextStyleProperties Functions

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

ArticleControl.getChildControls( )

Returns an array of controls that are immediate children of this control.

MessageProperties Functions

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

Control Functions

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

MessageContainer Functions

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

Element Functions

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