Class 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 HasFile 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 FileName, FileType, FileSize to get the original client-side file name, the file mime type, and the file size information. If the upload is not successful, ErrorCode contains the error code describing the cause of failure. TActiveFileUpload raises 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 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.
Constants Inherited From TControl |
AUTOMATIC_ID_PREFIX,
CLIENT_ID_SEPARATOR,
CS_CHILD_INITIALIZED,
CS_CONSTRUCTED,
CS_INITIALIZED,
CS_LOADED,
CS_PRERENDERED,
CS_STATE_LOADED,
ID_FORMAT,
ID_SEPARATOR,
IS_CHILD_CREATED,
IS_CREATING_CHILD,
IS_DISABLE_THEMING,
IS_DISABLE_VIEWSTATE,
IS_ID_SET,
IS_SKIN_APPLIED,
IS_STYLESHEET_APPLIED,
RF_ADAPTER,
RF_AUTO_BINDINGS,
RF_CHILD_STATE,
RF_CONTROLS,
RF_CONTROLSTATE,
RF_DATA_BINDINGS,
RF_EVENTS,
RF_NAMED_CONTROLS,
RF_NAMED_CONTROLS_ID,
RF_NAMED_OBJECTS,
RF_SKIN_ID,
|
Constructor Summary |
public |
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.
|
Method Summary |
void
|
Adds ID attribute, and renders the javascript for active component.
|
void
|
|
TBaseActiveCallbackControl
|
|
protected
string
|
|
boolean
|
|
TImage
|
|
string
|
|
protected
string
|
|
protected
array
|
Gets the client side options for this control.
|
TImage
|
|
TImage
|
|
string
|
|
void
|
This method is invoked when a file is uploaded.
|
void
|
|
void
|
Publish the javascript
|
void
|
Removes localfile on ending of the callback.
|
void
|
Raises OnFileUpload event.
|
boolean
|
saveAs
( string $fileName, boolean $deleteTempFile)
Saves the uploaded file.
|
void
|
|
void
|
|
Methods Inherited From TFileUpload |
TFileUpload::addAttributesToRender(), TFileUpload::getDataChanged(), TFileUpload::getErrorCode(), TFileUpload::getFileName(), TFileUpload::getFileSize(), TFileUpload::getFileType(), TFileUpload::getHasFile(), TFileUpload::getIsValid(), TFileUpload::getLocalName(), TFileUpload::getMaxFileSize(), TFileUpload::getTagName(), TFileUpload::getValidationPropertyValue(), TFileUpload::loadPostData(), TFileUpload::onFileUpload(), TFileUpload::onPreRender(), TFileUpload::raisePostDataChangedEvent(), TFileUpload::saveAs(), TFileUpload::setIsValid(), TFileUpload::setMaxFileSize()
|
Methods Inherited From TWebControl |
TWebControl::addAttributesToRender(), TWebControl::clearStyle(), TWebControl::copyBaseAttributes(), TWebControl::createStyle(), TWebControl::getAccessKey(), TWebControl::getBackColor(), TWebControl::getBorderColor(), TWebControl::getBorderStyle(), TWebControl::getBorderWidth(), TWebControl::getCssClass(), TWebControl::getDisplay(), TWebControl::getFont(), TWebControl::getForeColor(), TWebControl::getHasStyle(), TWebControl::getHeight(), TWebControl::getStyle(), TWebControl::getTabIndex(), TWebControl::getTagName(), TWebControl::getToolTip(), TWebControl::getWidth(), TWebControl::render(), TWebControl::renderBeginTag(), TWebControl::renderContents(), TWebControl::renderEndTag(), TWebControl::setAccessKey(), TWebControl::setBackColor(), TWebControl::setBorderColor(), TWebControl::setBorderStyle(), TWebControl::setBorderWidth(), TWebControl::setCssClass(), TWebControl::setDisplay(), TWebControl::setForeColor(), TWebControl::setHeight(), TWebControl::setStyle(), TWebControl::setTabIndex(), TWebControl::setToolTip(), TWebControl::setWidth()
|
Methods Inherited From TControl |
TControl::addedControl(), TControl::addParsedObject(), TControl::addToPostDataLoader(), TControl::applyStyleSheetSkin(), TControl::autoBindProperty(), TControl::autoDataBindProperties(), TControl::bindProperty(), TControl::broadcastEvent(), TControl::bubbleEvent(), TControl::clearChildState(), TControl::clearControlState(), TControl::clearNamingContainer(), TControl::clearViewState(), TControl::convertUniqueIdToClientId(), TControl::createChildControls(), TControl::createControlCollection(), TControl::dataBind(), TControl::dataBindChildren(), TControl::dataBindProperties(), TControl::ensureChildControls(), TControl::findControl(), TControl::findControlsByID(), TControl::findControlsByType(), TControl::focus(), TControl::getAdapter(), TControl::getAllowChildControls(), TControl::getAttribute(), TControl::getAttributes(), TControl::getChildControlsCreated(), TControl::getClientID(), TControl::getControls(), TControl::getControlStage(), TControl::getControlState(), TControl::getCustomData(), TControl::getEnabled(), TControl::getEnableTheming(), TControl::getEnableViewState(), TControl::getHasAdapter(), TControl::getHasAttributes(), TControl::getHasChildInitialized(), TControl::getHasControls(), TControl::getHasInitialized(), TControl::getHasLoaded(), TControl::getHasLoadedPostData(), TControl::getHasPreRendered(), TControl::getID(), TControl::getNamingContainer(), TControl::getPage(), TControl::getParent(), TControl::getRegisteredObject(), TControl::getSkinID(), TControl::getSourceTemplateControl(), TControl::getTemplateControl(), TControl::getUniqueID(), TControl::getViewState(), TControl::getVisible(), TControl::hasAttribute(), TControl::initRecursive(), TControl::isDescendentOf(), TControl::isObjectRegistered(), TControl::loadRecursive(), TControl::loadState(), TControl::loadStateRecursive(), TControl::onDataBinding(), TControl::onInit(), TControl::onLoad(), TControl::onPreRender(), TControl::onUnload(), TControl::preRenderRecursive(), TControl::raiseBubbleEvent(), TControl::registerObject(), TControl::removeAttribute(), TControl::removedControl(), TControl::render(), TControl::renderChildren(), TControl::renderControl(), TControl::saveState(), TControl::saveStateRecursive(), TControl::setAdapter(), TControl::setAttribute(), TControl::setChildControlsCreated(), TControl::setControlStage(), TControl::setControlState(), TControl::setCustomData(), TControl::setEnabled(), TControl::setEnableTheming(), TControl::setEnableViewState(), TControl::setID(), TControl::setPage(), TControl::setSkinID(), TControl::setTemplateControl(), TControl::setViewState(), TControl::setVisible(), TControl::trackViewState(), TControl::traverseChildControls(), TControl::unbindProperty(), TControl::unloadRecursive(), TControl::unregisterObject(), TControl::__get()
|
Methods Inherited From TComponent |
TComponent::addParsedObject(), TComponent::attachEventHandler(), TComponent::canGetProperty(), TComponent::canSetProperty(), TComponent::createdOnTemplate(), TComponent::detachEventHandler(), TComponent::evaluateExpression(), TComponent::evaluateStatements(), TComponent::getEventHandlers(), TComponent::getSubProperty(), TComponent::hasEvent(), TComponent::hasEventHandler(), TComponent::hasProperty(), TComponent::raiseEvent(), TComponent::setSubProperty(), TComponent::__get(), TComponent::__set()
|
Constructor Details |
__construct
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.
|
Method Details |
addAttributesToRender
public void addAttributesToRender |
(THtmlWriter $writer ) |
Adds ID attribute, and renders the javascript for active component.
Input |
THtmlWriter | $writer | the writer used for the rendering purpose |
Output |
Exception |
|
createChildControls
public void createChildControls |
() |
|
getActiveControl
|
getAssetUrl
protected string getAssetUrl |
(string $file ) |
Input |
string | $file | asset file in the self::SCRIPT_PATH directory. |
Output |
string
| asset file url. |
Exception |
|
getAutoPostBack
public boolean getAutoPostBack |
() |
Output |
boolean
| a value indicating whether an automatic callback to the server will occur whenever the user modifies the text in the TTextBox control and then tabs out of the component. Defaults to true. Note: When set to false, you will need to trigger the callback yourself. |
Exception |
|
getBusyImage
Output |
TImage
| the image displayed when an upload is in progress. |
Exception |
|
getCallbackJavascript
public string getCallbackJavascript |
() |
Output |
string
| A chuck of javascript that will need to be called if {AutoPostBack is set to false} |
Exception |
|
getClientClassName
protected string getClientClassName |
() |
Output |
string
| corresponding javascript class name for this control. |
Exception |
|
getClientOptions
protected array getClientOptions |
() |
Gets the client side options for this control.
Output |
array
| ( inputID => input client ID, flagID => flag client ID, targetName => target unique ID, formID => form client ID, indicatorID => upload indicator client ID, completeID => complete client ID, errorID => error client ID) |
Exception |
|
getErrorImage
public TImage getErrorImage |
() |
Output |
TImage
| the image displayed when an upload does not complete successfully. |
Exception |
|
getSuccessImage
public TImage getSuccessImage |
() |
Output |
TImage
| the image displayed when an upload completes successfully. |
Exception |
|
getTempPath
public string getTempPath |
() |
Output |
string
| the path where the uploaded file will be stored temporarily, in namespace format default "Application.runtime.*" |
Exception |
|
onFileUpload
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.
Input |
TEventParameter | $param | event parameter to be passed to the event handlers |
Output |
Exception |
|
onInit
public void onInit |
(mixed $sender ) |
Input |
mixed | $sender | |
Output |
Exception |
throws | TInvalidDataValueException if the TempPath is not writable. |
|
onPreRender
public void onPreRender |
(mixed $param ) |
Publish the javascript
Input |
mixed | $param | |
Output |
Exception |
|
onUnload
public void onUnload |
(mixed $param ) |
Removes localfile on ending of the callback.
Input |
mixed | $param | |
Output |
Exception |
|
raiseCallbackEvent
Raises OnFileUpload event.
This method is required by ICallbackEventHandler interface. This method is mainly used by framework and control developers.
|
saveAs
public boolean saveAs |
(string $fileName , boolean $deleteTempFile ) |
Saves the uploaded file.
Input |
string | $fileName | the file name used to save the uploaded file |
boolean | $deleteTempFile | whether to delete the temporary file after saving. If true, you will not be able to save the uploaded file again. |
Output |
boolean
| true if the file saving is successful |
Exception |
|
setAutoPostBack
public void setAutoPostBack |
(boolean $value ) |
Input |
boolean | $value | a value indicating whether an automatic callback to the server will occur whenever the user modifies the text in the TTextBox control and then tabs out of the component. Defaults to true. Note: When set to false, you will need to trigger the callback yourself. |
Output |
Exception |
|
setTempPath
public void setTempPath |
(string $value ) |
Input |
string | $value | the path where the uploaded file will be stored temporarily in namespace format default "Application.runtime.*" |
Output |
Exception |
|
Constant Details |
SCRIPT_PATH
Type:
string
Value:
'prado/activefileupload'
|
|