IDocumentGroup¶
- class IDocumentGroup¶
Bases:
ImpactCOMWrapperBase- Description:
Represents a document group used for categorising similar documents.
- 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_all_extensions¶
Gets allow_all_extensions.
- Description:
Determines if any document regardless of file extension can be associated with this document group.
- Returns:
The value of allow_all_extensions.
- Return type:
allow_all_extensions (bool)
- property can_delete¶
Gets can_delete.
- Description:
Determines if the group can be safely deleted.
- Remarks:
A group cannot be deleted if it has associated documents.
- Returns:
The value of can_delete.
- Return type:
can_delete (bool)
- property default_extensions¶
Gets default_extensions.
- Description:
A list of file extensions that are valid for this document group object.
- Remarks:
A semi-colon separated list of file extensions. default_extensions should not include the period character and are case-insensitive. When documents are added the first matching IDocumentGroup based on it’s file extension is located. The groups are searched ordered by the Name property. The allow_all_extensions property can be set to allow any document to be associated with this group not just those specified in default_extensions.
- Returns:
The value of default_extensions.
- Return type:
default_extensions (str)
- Examples:
- property id¶
Gets ID.
- Description:
A unique ID of the document group.
- Remarks:
When assigning document groups to an IDatabaseValues you must use the value of the ID property. When assigning document groups to an IDocumentCriterion.values property you must use the value of the ID property. Introduced in Impact 10.0.0.69
- Returns:
The value of ID.
- Return type:
id (str)
- property name¶
Gets Name.
- Description:
The name of the document group.
- Returns:
The value of Name.
- Return type:
name (str)
- property name_translated_xml¶
Gets name_translated_xml.
- Description:
The XML used to store translations for the Name property.
- Remarks:
This property is used internally.
- Returns:
The value of name_translated_xml.
- Return type:
name_translated_xml (str)
- delete()¶
- Description:
Permanently deletes the document group.
- Remarks:
You should check can_delete to determine if you can delete a group.
- do_update()¶
- Description:
Update the modified group directly in the database.
- Remarks:
When modifying one or more group properties update all the values with a single call to do_update.
- name_translated(language_id, exact_language_match)¶
- Description:
Gets the translated version of the document group 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.