The CompressorObject object provides the ability to compress the folder or file(s), or the byte data stream.
Note
CompressorObject (as well as HTTPClient, RESTClient, CrypterObject, CoderObject, DotNetAssembly, JSONGenerator, JSONParser, JSONPackage, OAuthClient, PDF Builder objects, SMTPClient, PowerServerLabel, PowerServerResult) does not support multi-threading.
CompressorObject property |
Datatype |
Description |
---|---|---|
ClassDefinition |
PowerObject |
An object of type PowerObject containing information about the class definition of the object or control. |
CompressionLevel (enumerated) |
Specifies the compression level at which the file or folder is compressed. |
|
String |
Specifies the password when the archive is encrypted. |
CompressorObject event |
Occurs |
---|---|
Immediately before the Open event occurs in the window |
|
Immediately after the Close event occurs in the window |
|
Occurs when an error is found in the file compression operation. |
|
Occurs when the file compression is completed. |
|
Occurs during the file compression process. This event can be used to display the full path name of the file or folder that is being compressed. |
|
Occurs during the file compression process. This event can be used to display the total number of bytes in the file or folder that has been compressed. |
|
Occurs before the file compression starts. This event can be used to display the total number of bytes in the file or folder that will be compressed. |
CompressorObject function |
Datatype returned |
Description |
---|---|---|
Integer |
Cancels the file compression operation. Only used for the asynchronous interface. |
|
String |
Returns the name assigned to the control |
|
Integer |
Compresses the folder or one or more files, or the byte data stream. |
|
Integer |
Creates a reference to a context-specific instance of the specified service |
|
PowerObject |
Returns a reference to the name of the parent object |
|
Boolean |
Adds an event to the end of the message queue for the object |
|
Integer |
Triggers a specified event in the control and executes the script for the event |
|
Object |
Returns the type of the object |