IDocumentColumns¶
- class IDocumentColumns¶
Bases:
ImpactCOMWrapperBase,Iterable- Description:
A collection of IDocumentColumns objects.
- Remarks:
Introduced in Impact 9.0.0.83.
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property count¶
Gets Count.
- Description:
The number of items in this collection.
- Returns:
The value of Count.
- Return type:
count (int)
- custom_item(custom_column_name)¶
- Description:
Gets an IDocumentColumn for a custom document column.
- Remarks:
This function ignores IDocumentColumn’s for known columns and only compares dkcCustom columns.
- Parameters:
custom_column_name (str) – Specifies the name of the document column to get.
- item(index)¶
- Description:
Gets an IDocumentColumn object with the specified name or index.
- Parameters:
index (any) – Specifies the index of the IDocumentColumn object to get.
- known_item(known_column)¶
- Description:
Gets an IDocumentColumn object for a specified ipDocumentKnownColumn.
- Remarks:
Passing dkcCustom as the known_column parameter will result in an error. If the underlying document provider does not support the column then null is returned.
- Parameters:
known_column (ipDocumentKnownColumn) – Specifies the ipDocumentKnownColumn of the column to get.