InitiateUploadControl
InitiateUploadControl Functions
| getAssociatedUploadControl | InitiateUploadControl.getAssociatedUploadControl( ) | Returns the associated FileUpload control if one exists |
ButtonControlProperties Functions
| getButtonText | InitiateUploadControl.getButtonText( ) | Returns the com.ebasetech.xi.api.Text object for the button text. |
| isDisabled | InitiateUploadControl.isDisabled( ) | Returns true if the button is marked as disabled, otherwise returns false. |
| setDisabled | InitiateUploadControl.setDisabled( disabled ) | Disables the button and results in the HTML disabled attribute being added to the <button> HTML tag. |
| getMouseOverText | InitiateUploadControl.getMouseOverText( ) | Returns the com.ebasetech.xi.api.Text object for the mouse over text. |
| isSkipValidation | InitiateUploadControl.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 | InitiateUploadControl.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 | InitiateUploadControl.addCssClass( cssClass ) | Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes. |
| getAll | InitiateUploadControl.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 | InitiateUploadControl.isContainer( ) | Returns true if this control is a container control i.e. |
| getCssClass | InitiateUploadControl.getCssClass( ) | Returns the list of CSS classes configured for the control. |
| setCssClass | InitiateUploadControl.setCssClass( cssClass ) | Sets one or more CSS classes to be applied to the control. |
| isDisplayOnly | InitiateUploadControl.isDisplayOnly( ) | Returns true if the control is marked as display only, otherwise returns false. |
| setDisplayOnly | InitiateUploadControl.setDisplayOnly( displayOnly ) | Marks the control and all its children as display only (when displayOnly is true) or
enterable (when displayOnly is false). |
| isDisplayOnlyIncludingParents | InitiateUploadControl.isDisplayOnlyIncludingParents( ) | Returns true if the control or any of its parents is marked as display only, otherwise returns false. |
| getErrorMsgClass | InitiateUploadControl.getErrorMsgClass( ) | Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgClass | InitiateUploadControl.setErrorMsgClass( errorMsgClass ) | Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control. |
| getErrorMsgStyle | InitiateUploadControl.getErrorMsgStyle( ) | Returns the inline CSS style configured for error messages when the messages are displayed locally to the control. |
| setErrorMsgStyle | InitiateUploadControl.setErrorMsgStyle( errorMsgStyle ) | Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control. |
| isEventField | InitiateUploadControl.isEventField( ) | Returns true if the control is an event field i.e. |
| hasModifier | InitiateUploadControl.hasModifier( modifier ) | Returns true if the control has the specified modifier, otherwise returns false. |
| isHidden | InitiateUploadControl.isHidden( ) | Returns true if the control is marked as hidden, otherwise returns false. |
| setHidden | InitiateUploadControl.setHidden( hidden ) | Hides or shows the control and all its children. |
| hide | InitiateUploadControl.hide( ) | Hides the control, this is equivalent to setting property hidden to true. |
| getInfoMsgClass | InitiateUploadControl.getInfoMsgClass( ) | Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgClass | InitiateUploadControl.setInfoMsgClass( infoMsgClass ) | Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control. |
| getInfoMsgStyle | InitiateUploadControl.getInfoMsgStyle( ) | Returns the inline CSS style configured for info messages when the messages are displayed locally to the control. |
| setInfoMsgStyle | InitiateUploadControl.setInfoMsgStyle( infoMsgStyle ) | Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control. |
| isInheritMsg | InitiateUploadControl.isInheritMsg( ) | Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false. |
| getLayoutCell | InitiateUploadControl.getLayoutCell( ) | Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control. |
| isLocalMsg | InitiateUploadControl.isLocalMsg( ) | Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false. |
| isNewLine | InitiateUploadControl.isNewLine( ) | Returns the new line property. |
| setNewLine | InitiateUploadControl.setNewLine( newLine ) | Sets or unsets the control's new line property. |
| getNextSiblingControl | InitiateUploadControl.getNextSiblingControl( ) | Returns the control that appears after this control within the same parent, or null if no such control exists. |
| getPage | InitiateUploadControl.getPage( ) | Returns the com.ebasetech.xi.api.Page where this control is located. |
| getParentControl | InitiateUploadControl.getParentControl( ) | Returns this control's parent control or null if no such parent exists. |
| getPreviousSiblingControl | InitiateUploadControl.getPreviousSiblingControl( ) | Returns the control that appears before this control within the same parent, or null if no such control exists. |
| refresh | InitiateUploadControl.refresh( ) | Refreshes this control in the user's browser when the page is next displayed. |
| removeCssClass | InitiateUploadControl.removeCssClass( cssClass ) | Removes one or more CSS classes from the control. |
| requestFocus | InitiateUploadControl.requestFocus( ) | Sets the browser focus to the control. |
| getRootHtmlElementProperties | InitiateUploadControl.getRootHtmlElementProperties( ) | Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control |
| show | InitiateUploadControl.show( ) | Shows the control, this is equivalent to setting property hidden to false. |
| isShowing | InitiateUploadControl.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 | InitiateUploadControl.getStyle( ) | Returns the inline CSS style configured for the control. |
| setStyle | InitiateUploadControl.setStyle( style ) | Sets inline CSS style to be applied to the control. |
| getWarningMsgClass | InitiateUploadControl.getWarningMsgClass( ) | Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgClass | InitiateUploadControl.setWarningMsgClass( warningMsgClass ) | Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control. |
| getWarningMsgStyle | InitiateUploadControl.getWarningMsgStyle( ) | Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control. |
| setWarningMsgStyle | InitiateUploadControl.setWarningMsgStyle( warningMsgStyle ) | Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control. |
MessageProperties Functions
| getErrorMessageStyle | InitiateUploadControl.getErrorMessageStyle( ) | Returns the MessageStyleProperties object representing error message styling properties. |
| getInfoMessageStyle | InitiateUploadControl.getInfoMessageStyle( ) | Returns the MessageStyleProperties object representing info message styling properties. |
| getWarningMessageStyle | InitiateUploadControl.getWarningMessageStyle( ) | Returns the MessageStyleProperties object representing warning message styling properties. |
BackgroundStyleProperties Functions
| getBackgroundColor | InitiateUploadControl.getBackgroundColor( ) | Background color. |
| setBackgroundColor | InitiateUploadControl.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 | InitiateUploadControl.getBackgroundImage( ) | URL of the background image. |
| setBackgroundImage | InitiateUploadControl.setBackgroundImage( backgroundImage ) | Sets the URL of the background image. |
| getBackgroundImagePosition | InitiateUploadControl.getBackgroundImagePosition( ) | Background image position. |
| setBackgroundImagePosition | InitiateUploadControl.setBackgroundImagePosition( backgroundImagePosition ) | Sets the background image position. |
| getBackgroundImageRepeat | InitiateUploadControl.getBackgroundImageRepeat( ) | Background image repeat property. |
| setBackgroundImageRepeat | InitiateUploadControl.setBackgroundImageRepeat( backgroundImageRepeat ) | Sets the background image repeat property. |
BootstrapButtonStyle Functions
| getBootstrapSize | InitiateUploadControl.getBootstrapSize( ) | The current bootstrap size |
| setBootstrapSize | InitiateUploadControl.setBootstrapSize( alignment ) | Sets the bootstrap size. |
| getBootstrapState | InitiateUploadControl.getBootstrapState( ) | The current bootstrap state |
| setBootstrapState | InitiateUploadControl.setBootstrapState( alignment ) | Sets the bootstrap state. |
| getBootstrapStyle | InitiateUploadControl.getBootstrapStyle( ) | The current bootstrap style |
| setBootstrapStyle | InitiateUploadControl.setBootstrapStyle( alignment ) | Sets the bootstrap style. |
BorderStyleProperties Functions
| getBorderColor | InitiateUploadControl.getBorderColor( ) | Border color applied to all borders. |
| setBorderColor | InitiateUploadControl.setBorderColor( borderColor ) | Sets border color. |
| getBorderRadius | InitiateUploadControl.getBorderRadius( ) | Border radius. |
| setBorderRadius | InitiateUploadControl.setBorderRadius( borderRadius ) | Sets border radius. |
| getBorderStyle | InitiateUploadControl.getBorderStyle( ) | Border style applied to all borders. |
| setBorderStyle | InitiateUploadControl.setBorderStyle( borderStyle ) | Sets border style. |
| getBorderWidth | InitiateUploadControl.getBorderWidth( ) | Border width applied to all four borders. |
| setBorderWidth | InitiateUploadControl.setBorderWidth( borderWidth ) | Sets the border width applied to all four borders. |
| getBottomBorderWidth | InitiateUploadControl.getBottomBorderWidth( ) | Bottom border width, overriding property borderWidth. |
| setBottomBorderWidth | InitiateUploadControl.setBottomBorderWidth( bottomBorderWidth ) | Sets the bottom border width, overriding property borderWidth. |
| getLeftBorderWidth | InitiateUploadControl.getLeftBorderWidth( ) | Left border width, overriding property borderWidth. |
| setLeftBorderWidth | InitiateUploadControl.setLeftBorderWidth( leftBorderWidth ) | Sets the left border width, overriding property borderWidth. |
| getRightBorderWidth | InitiateUploadControl.getRightBorderWidth( ) | Right border width, overriding property borderWidth. |
| setRightBorderWidth | InitiateUploadControl.setRightBorderWidth( rightBorderWidth ) | Sets the right border width, overriding property borderWidth. |
| getTopBorderWidth | InitiateUploadControl.getTopBorderWidth( ) | Top border width, overriding property borderWidth. |
| setTopBorderWidth | InitiateUploadControl.setTopBorderWidth( topBorderWidth ) | Sets the top border width, overriding property borderWidth. |
MarginStyleProperties Functions
| getAllMargin | InitiateUploadControl.getAllMargin( ) | Single MarginStyleProperties size value used for top, bottom, left and right margin. |
| setAllMargin | InitiateUploadControl.setAllMargin( allMargin ) | Sets the MarginStyleProperties size value used for top, bottom, left and right margin. |
| getBottomMargin | InitiateUploadControl.getBottomMargin( ) | Bottom MarginStyleProperties size value. |
| setBottomMargin | InitiateUploadControl.setBottomMargin( bottomMargin ) | Sets the bottom MarginStyleProperties size value. |
| getLeftMargin | InitiateUploadControl.getLeftMargin( ) | Left MarginStyleProperties size value. |
| setLeftMargin | InitiateUploadControl.setLeftMargin( leftMargin ) | Sets the left MarginStyleProperties size value. |
| getRightMargin | InitiateUploadControl.getRightMargin( ) | Right MarginStyleProperties size value. |
| setRightMargin | InitiateUploadControl.setRightMargin( rightMargin ) | Sets the right MarginStyleProperties size value. |
| getTopMargin | InitiateUploadControl.getTopMargin( ) | Top MarginStyleProperties size value. |
| setTopMargin | InitiateUploadControl.setTopMargin( topMargin ) | Sets the top MarginStyleProperties size value. |
PaddingStyleProperties Functions
| getAllPadding | InitiateUploadControl.getAllPadding( ) | Single PaddingStyleProperties size value used for top, bottom, left and right padding. |
| setAllPadding | InitiateUploadControl.setAllPadding( allPadding ) | Sets the PaddingStyleProperties size value used for top, bottom, left and right padding. |
| getBottomPadding | InitiateUploadControl.getBottomPadding( ) | Bottom PaddingStyleProperties size value. |
| setBottomPadding | InitiateUploadControl.setBottomPadding( bottomPadding ) | Sets the bottom PaddingStyleProperties size value. |
| getLeftPadding | InitiateUploadControl.getLeftPadding( ) | Left PaddingStyleProperties size value. |
| setLeftPadding | InitiateUploadControl.setLeftPadding( leftPadding ) | Sets the left PaddingStyleProperties size value. |
| getRightPadding | InitiateUploadControl.getRightPadding( ) | Right PaddingStyleProperties size value. |
| setRightPadding | InitiateUploadControl.setRightPadding( rightPadding ) | Sets the right PaddingStyleProperties size value. |
| getTopPadding | InitiateUploadControl.getTopPadding( ) | Top PaddingStyleProperties size value. |
| setTopPadding | InitiateUploadControl.setTopPadding( topPadding ) | Sets the top PaddingStyleProperties size value. |
TextStyleProperties Functions
| getLineHeight | InitiateUploadControl.getLineHeight( ) | Line height. |
| setLineHeight | InitiateUploadControl.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 | InitiateUploadControl.getTextBold( ) | Text bold setting. |
| setTextBold | InitiateUploadControl.setTextBold( textBold ) | Sets the text bold setting. |
| getTextColor | InitiateUploadControl.getTextColor( ) | Text color. |
| setTextColor | InitiateUploadControl.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 | InitiateUploadControl.getTextDecoration( ) | Text decoration property (shown as Lines in the designer). |
| setTextDecoration | InitiateUploadControl.setTextDecoration( textDecoration ) | Sets the text decoration property (shown as Lines in the designer). |
| getTextFont | InitiateUploadControl.getTextFont( ) | List of text fonts. |
| setTextFont | InitiateUploadControl.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 | InitiateUploadControl.getTextItalic( ) | Text italic setting. |
| setTextItalic | InitiateUploadControl.setTextItalic( textItalic ) | Sets the text italic setting. |
| getTextSize | InitiateUploadControl.getTextSize( ) | Text size. |
| setTextSize | InitiateUploadControl.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 | InitiateUploadControl.addErrorMessage( message [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessage | InitiateUploadControl.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user. |
| addErrorMessageText | InitiateUploadControl.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an error message that will be displayed to the user, sourced from an existing text. |
| addInfoMessage | InitiateUploadControl.addInfoMessage( message [, stopProcessing ] ) | Adds an information message that will be displayed to the user. |
| addInfoMessageText | InitiateUploadControl.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds an info message that will be displayed to the user, sourced from an existing text. |
| addWarningMessage | InitiateUploadControl.addWarningMessage( message [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessage | InitiateUploadControl.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user. |
| addWarningMessageText | InitiateUploadControl.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) | Adds a warning message that will be displayed to the user, sourced from an existing text. |
| existErrorMessages | InitiateUploadControl.existErrorMessages( ) | Returns true if undisplayed error messages exist for this element, otherwise returns false. |
| existInfoMessages | InitiateUploadControl.existInfoMessages( ) | Returns true if undisplayed info messages exist for this element, otherwise returns false. |
| existMessages | InitiateUploadControl.existMessages( ) | Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false. |
| existWarningMessages | InitiateUploadControl.existWarningMessages( ) | Returns true if undisplayed warning messages exist for this element, otherwise returns false. |
Element Functions
| getElementName | InitiateUploadControl.getElementName( ) | Returns the element name |
| getElementType | InitiateUploadControl.getElementType( ) | Returns the element type |
Further documentation.