This documentation is for the old version. Go to the latest Upload Suite docs

BaseControl Class

Base class for all Image Uploader controls. BaseControl is an abstract class which implements common functionality for Image Uploader controls. You cannot instantiate objects of this class directly.

The following tables list the members exposed by the BaseControl type.

Properties

Name Description
public property getActiveXControlCabFileName()
setActiveXControlCabFileName($value)
Gets or sets URL that specifies where to download the ActiveX version of Image Uploader from. It is analogous to the codebase attribute of the OBJECT element. This property is used to embed stand-alone or private-label version of Image Uploader. See the Using Stand-Alone Versions of Controls in Image Uploader PHP topic for details.
public property getActiveXControlClassId()
setActiveXControlClassId($value)
Gets or sets CLSID of the ActiveX control. This property is used to embed stand-alone or private-label version of Image Uploader. See the Using Stand-Alone Versions of Controls in Image Uploader PHP topic for details.
public property getActiveXControlEnabled()
setActiveXControlEnabled($value)
Gets or sets switch that specifies whether to use ActiveX version of Image Uploader.
public property getActiveXControlProgId()
setActiveXControlProgId($value)
Gets or sets PROGID of the ActiveX control. This property is used to embed stand-alone or private-label version of Image Uploader. See the Using Stand-Alone Versions of Controls in Image Uploader PHP topic for details.
public property getActiveXControlVersion()
setActiveXControlVersion($value)
Gets or sets the minimum required version of the ActiveX version (*.cab file).
public property getHeight()
setHeight($value)
Gets or sets height of the control in pixels.
public property getId()
setId($value)
Gets or sets the identifier assigned to the control.
public property getInstallationProgress() Gets InstallationProgress which is used to configure downloading and installation instructions.
public property getJavaAppletClassName()
setJavaAppletClassName($value)
Gets or sets class name of the Image Uploader Java applet. This property is used to embed stand-alone or private-label version of Image Uploader. See the Using Stand-Alone Versions of Controls in Image Uploader PHP topic for details.
public property getJavaAppletEnabled()
setJavaAppletEnabled($value)
Gets or sets switch that specifies whether to use Java version of Image Uploader.
public property getJavaAppletJarFileName()
setJavaAppletJarFileName($value)
Gets or sets URL that specifies where to download the Java version of Image Uploader from. This property is used to embed stand-alone or private-label version of Image Uploader. See the Using Stand-Alone Versions of Controls in Image Uploader PHP topic for details.
public property getJavaAppletVersion()
setJavaAppletVersion($value)
Gets or sets the minimum required version of the Java version (*.jar file).
public property getJavaScriptWriterVariableName() Gets the name of the ImageUploaderWriter object.
public property getScriptsDirectory()
setScriptsDirectory($value)
Gets or sets URL that specifies where to download stand-alone Image Uploader-related (*.cab, *.jar, and *.js) files from. This property is used to embed stand-alone or private-label version of Image Uploader. See the Using Stand-Alone Versions of Controls in Image Uploader PHP topic for details.
public property getWidth()
setWidth($value)
Gets or sets width of the control in pixels.

Methods

Name Description
public method registerClientScripts($scriptFiles) Registers $scriptFiles Image Uploader embedding scripts.

Events

Name Description
public event addClientFullPageLoad($clientFunction)
removeClientFullPageLoad($clientFunction)
Adds or removes a handler of the event which fires after Image Uploader is completely initialized and all other page elements are loaded. It is recommended to use this event instead of the window.onload, because it guarantees that ActiveX control or Java applet is completely created and initialized.
public event addClientInitWriter($clientFunction)
removeClientInitWriter($clientFunction)
Adds or removes a handler of the event which fires just before initialization of ActiveX control or Java applet. It accepts the writer parameter which represents ImageUploaderWriter object. Using this parameter you can modify settings of Image Uploader on the client side before it is instantiated.