Class \Prado\Web\UI\ActiveControls\TActiveFileUpload

TActiveFileUpload

TActiveFileUpload displays a file upload field on a page. Upon postback, the text entered into the field will be treated as the name of the file that will be uploaded to the server. The property \Prado\Web\UI\ActiveControls\getHasFile indicates whether the file upload is successful. If successful, the file may be obtained by calling saveAs to save it at a specified place. You can use \Prado\Web\UI\ActiveControls\getFileName, \Prado\Web\UI\ActiveControls\getFileType, \Prado\Web\UI\ActiveControls\getFileSize to get the original client-side file name, the file mime type, and the file size information. If the upload is not successful, \Prado\Web\UI\ActiveControls\getErrorCode contains the error code describing the cause of failure.

TActiveFileUpload raises \Prado\Web\UI\ActiveControls\onFileUpload event if a file is uploaded (whether it succeeds or not).

TActiveFileUpload actually does a postback in a hidden IFrame, and then does a callback. This callback then raises the \Prado\Web\UI\ActiveControls\onFileUpload event. After the postback a status icon is displayed; either a green checkmark if the upload is successful, or a red x if there was an error.

TActiveFileUpload needs either an application level cache or a security manager to work securely.

Since Prado 4.0 the TActiveFileUpload supports HTML5 multiple file uploads by setting the \Prado\Web\UI\ActiveControls\setMultiple attribute to true. See the description of the parent class TFileUpload for further details.

Class hierarchy

\Prado\Web\UI\ActiveControls\TActiveFileUpload implements IActiveControl, ICallbackEventHandler, INamingContainer

\Prado\Web\UI\WebControls\TFileUpload implements IPostBackDataHandler, IValidatable

\Prado\Web\UI\WebControls\TWebControl implements IStyleable

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Bradley Booms <Bradley.Booms@nsighttel.com>
Author: Christophe Boulain <Christophe.Boulain@gmail.com>
Author: LANDWEHR Computer und Software GmbH <programmierung@landwehr-software.de>

Methods summary
`public`	`__construct() : mixed` Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.
`public`	`addAttributesToRender(THtmlWriter $writer) : mixed` Adds ID attribute, and renders the javascript for active component.
`public`	`createChildControls() : mixed`
`public`	`getActiveControl() : TBaseActiveCallbackControl`
`public`	`getAutoPostBack() : bool`
`public`	`getBusyImage() : TImage`
`public`	`getCallbackJavascript() : string`
`public`	`getClientSide() : TCallbackClientSide`
`public`	`getErrorImage() : TImage`
`public`	`getSuccessImage() : TImage`
`public`	`getTempPath() : string`
`public`	`onFileUpload(TEventParameter $param) : mixed` This method is invoked when a file is uploaded. If you override this method, be sure to call the parent implementation to ensure the invocation of the attached event handlers.
`public`	`onInit(mixed $sender) : mixed`
`public`	`onPreRender(mixed $param) : mixed` Publish the javascript
`public`	`onUnload(mixed $param) : mixed` Removes localfile on ending of the callback.
`public`	`raiseCallbackEvent(TCallbackEventParameter $param) : mixed` Raises <b>OnFileUpload</b> event. This method is required by ICallbackEventHandler interface. This method is mainly used by framework and control developers.
`public`	`raisePostDataChangedEvent() : mixed` Raises postdata changed event. This method calls onFileUpload method This method is primarily used by framework developers.
`public`	`setAutoPostBack(bool $value) : mixed`
`public`	`setTempPath(string $value) : mixed`
`protected`	`getAssetUrl([string $file = '' ]) : string`
`protected`	`getClientClassName() : string`
`protected`	`getClientOptions() : array<string\|int, mixed>` Gets the client side options for this control.
`protected`	`popParamsByToken(mixed $token) : mixed`
`protected`	`pushParamsAndGetToken(TActiveFileUploadCallbackParams $params) : mixed`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearStyle, clearViewState, convertUniqueIdToClientId, copyBaseAttributes, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getClassHierarchy, getClientID, getControls, getCssClass, getCustomData, getDataChanged, getDecorator, getDisplay, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getErrorCode, getEventHandlers, getFileName, getFiles, getFileSize, getFileType, getFont, getForeColor, getHasAdapter, getHasAllFiles, getHasAttributes, getHasChildInitialized, getHasControls, getHasFile, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getIsValid, getListeningToGlobalEvents, getLocalName, getMaxFileSize, getMultiple, getNamingContainer, getPage, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getToolTip, getUniqueID, getUser, getValidationPropertyValue, getViewState, getVisible, getWidth, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadPostData, loadState, onDataBinding, onFileUpload, onInit, onLoad, onPreRender, onUnload, publishAsset, publishFilePath, raiseEvent, raisePostDataChangedEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, saveAs, saveState, setAccessKey, setAdapter, setAttribute, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCssClass, setCustomData, setDisplay, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setIsValid, setMaxFileSize, setMultiple, setPage, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setToolTip, setViewState, setVisible, setWidth, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createStyle, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getControlStage, getControlState, getTagName, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, preRenderRecursive, raiseBubbleEvent, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

Constants summary
`public mixed`	`SCRIPT_PATH`	`'activefileupload'`

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\WebControls\TFileUpload::MAX_FILE_SIZE, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\ActiveControls\TActiveFileUpload

Class hierarchy