IDocumentType¶
- class IDocumentType¶
Bases:
ImpactCOMWrapperBase- Description:
Represents a document type configured in the underlying document provider.
- Remarks:
Each document provider typically supports multiple document types. Each document type provides a set of document columns in which meta-data related to the document type can be stored. The document type is the intrinsic type that is allocated to each document when it is added to the document repository. Once a document has been created with a specific document type that type cannot be changed. 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 columns¶
Gets Columns.
- Description:
A IDocumentColumns collection containing all columns for this document type.
- Returns:
The value of Columns.
- Return type:
- property key¶
Gets Key.
- Description:
A unique document type key.
- Returns:
The value of Key.
- Return type:
key (str)
- property name¶
Gets Name.
- Description:
The document type name.
- Returns:
The value of Name.
- Return type:
name (str)
- property tag_column¶
Gets tag_column.
- Description:
Retrives the IDocumentColumn for tags if this document types supports tagging.
- Returns:
The value of tag_column.
- Return type:
- create_column_values()¶
- Description:
Creates a new IDatabaseValues object for setting document values.
- Remarks:
When adding or updating documents you can assign values using an IDatabaseValues object created using this function.
- Examples:
- name_translated(language_id, exact_language_match)¶
- Description:
Gets the translated version of the document type Name, in the language specified.
- Remarks:
You should check supports_translations to determine if translations are supported. For a more detailed explanation of the parameters, please see the notes for the master_setting_name_translated method.
- Parameters:
language_id (any) – A string or enum representing the language wanted.
exact_language_match (bool) – Specifies what to do if there is no translation for the specified language.