Class CKTables

Represents a collection of CKTable objects associated with a CKRange.

Inheritance
object
ACKRangeCollection
CKTables
Implements
Inherited Members
Namespace: CoverageKiller2.DOM.Tables
Assembly: CoverageKiller2.dll
Syntax
public class CKTables : ACKRangeCollection, IDOMObject, IEnumerable<CKTable>, IEnumerable
Remarks

Version: CK2.00.01.0001

Constructors

CKTables(Tables, CKDocument)

Initializes a new instance of the CKTables class from the specified parent range.

Declaration
public CKTables(Tables collection, CKDocument parent)
Parameters
Type Name Description
Tables collection

The Word tables collection.
CKDocument parent

The parent is the Document that owns the tables.
Remarks

In CSTO, the parent of a Tables collection is ALWAYS the document, regardles of the range it was pulled from

Properties

Count

Gets the number of items in the collection.

Declaration
public override int Count { get; }
Property Value
Type Description
int
Overrides

IsOrphan

Determines whether the collection has lost association with the underlying Word objects.

Declaration
public override bool IsOrphan { get; }
Property Value
Type Description
bool
Overrides

this[int]

Gets the CKTable at the specified one-based index.

Declaration
public CKTable this[int index] { get; }
Parameters
Type Name Description
int index

One-based index of the table.
Property Value
Type Description
CKTable

The corresponding CKTable.

Methods

Add(CKRange, int, int)

Adds a new CKTable at the specified range with the given number of rows and columns.

Declaration
public CKTable Add(CKRange insertAt, int numRows, int numColumns)
Parameters
Type Name Description
CKRange insertAt

The CKRange at which to insert the table.
int numRows

The number of rows in the new table.
int numColumns

The number of columns in the new table.
Returns
Type Description
CKTable

The newly created CKTable instance.
Remarks

Version: CK2.00.01.0006

Exceptions
Type Condition
ArgumentNullException
ArgumentOutOfRangeException

CheckDirtyFor()

Checks whether the collection has become dirty. Override in descendants to customize.

Declaration
protected override bool CheckDirtyFor()
Returns
Type Description
bool

True if dirty; otherwise, false.
Overrides

Clear()

Clears the collection cache.

Declaration
public override void Clear()
Overrides

Delete(CKTable)

Deletes the specified CKTable from the document.

Declaration
public void Delete(CKTable table)
Parameters
Type Name Description
CKTable table

The table to delete.
Exceptions
Type Condition
ArgumentNullException

Thrown if table is null.

Delete(int)

Deletes the table at the specified one-based index.

Declaration
public void Delete(int index)
Parameters
Type Name Description
int index

The one-based index of the table to delete.
Exceptions
Type Condition
ArgumentOutOfRangeException

Thrown if index is out of bounds.

GetEnumerator()

Declaration
public IEnumerator<CKTable> GetEnumerator()
Returns
Type Description
IEnumerator<CKTable>

IndexOf(object)

Attempts to find the index of an object within the collection.

Declaration
public override int IndexOf(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
int
Overrides

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Implements

Extension Methods