MaxIDE.Collect Object API



Identification

MaxIDE.Collect

Description

This is an object orientated collection wrapper that holds strings for VBScript and JScript.

Properties

Count (Long) (ReadOnly)

Description

Returns the number of strings in the collection.

Item (Key) (String) (ReadOnly)

Parameters

Key Variant

An existing key or index that refers to a string in the collection.

Description

Retrieves a string from the collection.

VBCollection (Collection)

Description

Refers to the raw VBA Collection type used in the wrapper.

Functions

Add (Data, [Key])

Parameters

Data String

Any string to add to the collection.

 

Key Variant

A key to refer directly to the newly added Data.

Description

Adds any string to the collection in ordinal.

Remove (Key)

Parameters

Key Variant

An existing key or index that refers to a string in the collection.

Description

Removes a string from the collection.

Clear ()

Description

Clears the collection.

Automation

Object:Init (self)

Parameters

self Object

A reference to the object.

Description

Optional event that is called when the object is initialized.

Object:Term (self)

Parameters

self Object

A reference to the object.

Description

Optional event that is called when the object is terminated.