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