CompressorObject object

The CompressorObject object provides the ability to compress the folder or file(s), or the byte data stream.

Properties

CompressorObject property

Datatype

Description

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.

Level

CompressionLevel (enumerated)

Specifies the compression level at which the file or folder is compressed.

Password

String

Specifies the password when the archive is encrypted.


Events

CompressorObject event

Occurs

Constructor

Immediately before the Open event occurs in the window

Destructor

Immediately after the Close event occurs in the window

Error

Occurs when an error is found in the file compression operation.

Finished

Occurs when the file compression is completed.

ProcessingFile

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.

SizeCompleted

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.

Start

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.


Functions

CompressorObject function

Datatype returned

Description

Cancel

Integer

Cancels the file compression operation. Only used for the asynchronous interface.

ClassName

String

Returns the name assigned to the control

Compress

Integer

Compresses the folder or one or more files, or the byte data stream.

GetContextService

Integer

Creates a reference to a context-specific instance of the specified service

GetParent

PowerObject

Returns a reference to the name of the parent object

PostEvent

Boolean

Adds an event to the end of the message queue for the object

TriggerEvent

Integer

Triggers a specified event in the control and executes the script for the event

TypeOf

Object

Returns the type of the object