ITableCollection module

class ITableCollection.ITableCollection

Bases: IDocumentObjectCollection, ICollectionBase, IEnumerable

Represents a collection of tables in a document.

abstract Add(table: ITable) → int

Adds a table to the collection.

Parameters:

table (ITable) – The table to add.

Returns:

The index at which the table was added.

Return type:

int

abstract Contains(table: ITable) → bool

Checks if the collection contains the specified table.

Parameters:

table (ITable) – The table to check.

Returns:

True if the table is in the collection, False otherwise.

Return type:

bool

abstract IndexOf(table: ITable) → int

Retrieves the index of the specified table.

Parameters:

table (ITable) – The table to find.

Returns:

The index of the table, or -1 if not found.

Return type:

int

abstract get_Item(index: int) → ITable

Retrieves the table at the specified index.

Parameters:

index (int) – The index of the table to retrieve.

Returns:

The table at the specified index.

Return type:

ITable