IDocumentColumn¶
- class IDocumentColumn¶
Bases:
ImpactCOMWrapperBase- Description:
Provides information about a configured document provider column.
- 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 allow_null¶
Gets allow_null.
- Description:
Determines if the document column value can be unassigned.
- Returns:
The value of allow_null.
- Return type:
allow_null (bool)
- property choice_values¶
Gets choice_values.
- Description:
Provides a list of valid values for a document column.
- Remarks:
This property can apply to both single and multi-valued columns. This property does not apply for columns whose known_column is dkcTags.
- Returns:
The value of choice_values.
- Return type:
choice_values (any)
- property header¶
Gets Header.
- Description:
The header to display for this document column.
- Returns:
The value of Header.
- Return type:
header (str)
- property known_column¶
Gets known_column.
- Description:
The known column identifier of the column.
- Remarks:
The underlying document provider may not support all ipDocumentKnownColumn’s.
- Returns:
The value of known_column.
- Return type:
- property length¶
Gets Length.
- Description:
The document column length.
- Remarks:
This property only applies to columns whose Type is dctCharacter.
- Returns:
The value of Length.
- Return type:
length (int)
- property max_value¶
Gets max_value.
- Description:
Determines the maximum value.
- Returns:
The value of max_value.
- Return type:
max_value (any)
- property min_value¶
Gets min_value.
- Description:
Determines the minimum value.
- Returns:
The value of min_value.
- Return type:
min_value (any)
- property multi_valued¶
Gets multi_valued.
- Description:
Determines if the document column values are multi-valued.
- Returns:
The value of multi_valued.
- Return type:
multi_valued (bool)
- property name¶
Gets Name.
- Description:
The name of the column.
- Remarks:
If you are storing external references to document columns you should use the known_column property if possible.
- Returns:
The value of Name.
- Return type:
name (str)
- property read_only¶
Gets read_only.
- Description:
Determines if the document column values are read-only.
- Returns:
The value of read_only.
- Return type:
read_only (bool)
- property type¶
Gets Type.
- Description:
The document column data type.
- Returns:
The value of Type.
- Return type:
- property use_min_max_values¶
Gets use_min_max_values.
- Description:
Determines if minimum and maximum values should be respected.
- Returns:
The value of use_min_max_values.
- Return type:
use_min_max_values (bool)