GridControl
GridControl Functions
| getCellBorder | GridControl.getCellBorder( ) | Border properties for each cell. |
| getColumnWidths | GridControl.getColumnWidths( ) | A comma separated list of column width percentages in the form 20%,20%,40%,20%. |
| setColumnWidths | GridControl.setColumnWidths( columnWidths ) | Sets the widths for the grid columns. |
| getGridClass | GridControl.getGridClass( ) | Returns the list of CSS classes applied to the table grid. |
| setGridClass | GridControl.setGridClass( gridClass ) | Sets one or more CSS classes to be applied to the table grid. |
| getGridStyle | GridControl.getGridStyle( ) | Returns the inline CSS style applied to the table grid. |
| setGridStyle | GridControl.setGridStyle( gridStyle ) | Sets the inline CSS style to be applied to the table grid. |
| getHeight | GridControl.getHeight( ) | Grid Control height. |
| setHeight | GridControl.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 | GridControl.getWidth( ) | Grid Control width. |
| setWidth | GridControl.setWidth( width ) | Sets the width of the Grid Control. |
BackgroundStyleProperties Functions
| getBackgroundColor | GridControl.getBackgroundColor( ) | Background color. |
| setBackgroundColor | GridControl.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 | GridControl.getBackgroundImage( ) | URL of the background image. |
| setBackgroundImage | GridControl.setBackgroundImage( backgroundImage ) | Sets the URL of the background image. |
| getBackgroundImagePosition | GridControl.getBackgroundImagePosition( ) | Background image position. |
| setBackgroundImagePosition | GridControl.setBackgroundImagePosition( backgroundImagePosition ) | Sets the background image position. |
| getBackgroundImageRepeat | GridControl.getBackgroundImageRepeat( ) | Background image repeat property. |
| setBackgroundImageRepeat | GridControl.setBackgroundImageRepeat( backgroundImageRepeat ) | Sets the background image repeat property. |
BorderStyleProperties Functions
| getBorderColor | GridControl.getBorderColor( ) | Border color applied to all borders. |
| setBorderColor | GridControl.setBorderColor( borderColor ) | Sets border color. |
| getBorderRadius | GridControl.getBorderRadius( ) | Border radius. |
| setBorderRadius | GridControl.setBorderRadius( borderRadius ) | Sets border radius. |
| getBorderStyle | GridControl.getBorderStyle( ) | Border style applied to all borders. |
| setBorderStyle | GridControl.setBorderStyle( borderStyle ) | Sets border style. |
| getBorderWidth | GridControl.getBorderWidth( ) | Border width applied to all four borders. |
| setBorderWidth | GridControl.setBorderWidth( borderWidth ) | Sets the border width applied to all four borders. |
| getBottomBorderWidth | GridControl.getBottomBorderWidth( ) | Bottom border width, overriding property borderWidth. |
| setBottomBorderWidth | GridControl.setBottomBorderWidth( bottomBorderWidth ) | Sets the bottom border width, overriding property borderWidth. |
| getLeftBorderWidth | GridControl.getLeftBorderWidth( ) | Left border width, overriding property borderWidth. |
| setLeftBorderWidth | GridControl.setLeftBorderWidth( leftBorderWidth ) | Sets the left border width, overriding property borderWidth. |
| getRightBorderWidth | GridControl.getRightBorderWidth( ) | Right border width, overriding property borderWidth. |
| setRightBorderWidth | GridControl.setRightBorderWidth( rightBorderWidth ) | Sets the right border width, overriding property borderWidth. |
| getTopBorderWidth | GridControl.getTopBorderWidth( ) | Top border width, overriding property borderWidth. |
| setTopBorderWidth | GridControl.setTopBorderWidth( topBorderWidth ) | Sets the top border width, overriding property borderWidth. |
ContainerControl Functions
| getChildControls | GridControl.getChildControls( ) | Returns an array of controls that are immediate children of this control. |
MarginStyleProperties Functions
| getAllMargin | GridControl.getAllMargin( ) | Single MarginStyleProperties size value used for top, bottom, left and right margin. |
| setAllMargin | GridControl.setAllMargin( allMargin ) | Sets the MarginStyleProperties size value used for top, bottom, left and right margin. |
| getBottomMargin | GridControl.getBottomMargin( ) | Bottom MarginStyleProperties size value. |
| setBottomMargin | GridControl.setBottomMargin( bottomMargin ) | Sets the bottom MarginStyleProperties size value. |
| getLeftMargin | GridControl.getLeftMargin( ) | Left MarginStyleProperties size value. |
| setLeftMargin | GridControl.setLeftMargin( leftMargin ) | Sets the left MarginStyleProperties size value. |
| getRightMargin | GridControl.getRightMargin( ) | Right MarginStyleProperties size value. |
| setRightMargin | GridControl.setRightMargin( rightMargin ) | Sets the right MarginStyleProperties size value. |
| getTopMargin | GridControl.getTopMargin( ) | Top MarginStyleProperties size value. |
| setTopMargin | GridControl.setTopMargin( topMargin ) | Sets the top MarginStyleProperties size value. |
TextStyleProperties Functions
| getLineHeight | GridControl.getLineHeight( ) | Line height. |
| setLineHeight | GridControl.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 | GridControl.getTextBold( ) | Text bold setting. |
| setTextBold | GridControl.setTextBold( textBold ) | Sets the text bold setting. |
| getTextColor | GridControl.getTextColor( ) | Text color. |
| setTextColor | GridControl.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 | GridControl.getTextDecoration( ) | Text decoration property (shown as Lines in the designer). |
| setTextDecoration | GridControl.setTextDecoration( textDecoration ) | Sets the text decoration property (shown as Lines in the designer). |
| getTextFont | GridControl.getTextFont( ) | List of text fonts. |
| setTextFont | GridControl.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 | GridControl.getTextItalic( ) | Text italic setting. |
| setTextItalic | GridControl.setTextItalic( textItalic ) | Sets the text italic setting. |
| getTextSize | GridControl.getTextSize( ) | Text size. |
| setTextSize | GridControl.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. |
Control Functions
| addCssClass | GridControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | GridControl.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 | GridControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | GridControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | GridControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | GridControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | GridControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | GridControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | GridControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | GridControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | GridControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | GridControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | GridControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | GridControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | GridControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | GridControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | GridControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | GridControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | GridControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | GridControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | GridControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | GridControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | GridControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | GridControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | GridControl.isNewLine( ) | Returns the new line property. |
| setNewLine | GridControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | GridControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | GridControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | GridControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | GridControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | GridControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | GridControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | GridControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | GridControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | GridControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | GridControl.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 | GridControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | GridControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | GridControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | GridControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | GridControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | GridControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
MessageContainer Functions
| addErrorMessage | GridControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | GridControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | GridControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | GridControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | GridControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | GridControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | GridControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | GridControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | GridControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | GridControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | GridControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | GridControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | GridControl.getElementName( ) | Returns the element name |
| getElementType | GridControl.getElementType( ) | Returns the element type |
Further documentation.