TableCollection module

class TableCollection.TableCollection

Bases: DocumentSubsetCollection, ITableCollection

Represents a collection of <see cref=”!:Spire.Doc.ITable” /> objects.

Add(table: ITable) int

Adds a table to the end of the text body.

Parameters:

table – The table to be added.

Returns:

The index of the added table.

Contains(table: ITable) bool

Determines whether the collection contains a specific table.

Parameters:

table – The table to be checked.

Returns:

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

IndexOf(table: ITable) int

Determines the index of a specific table in the collection.

Parameters:

table – The table to find the index of.

Returns:

The index of the table in the collection.

Insert(index: int, table: ITable) int

Inserts a table into the collection at the specified index.

Parameters:
  • index – The index at which to insert the table.

  • table – The table to be inserted.

Returns:

The index of the inserted table.

Remove(table: ITable)

Removes the specified table from the collection.

Parameters:

table – The table to be removed.

RemoveAt(index: int)

Removes the table at the specified index from the collection.

Parameters:

index – The index of the table to be removed.

get_Item(index: int) ITable

Retrieves the table at the specified index.

Parameters:

index – The index of the table.

Returns:

The table at the specified index.