IDocumentGroups

class IDocumentGroups

Bases: ImpactCOMWrapperBase, Iterable

Summary:

A collection of IDocumentGroup objects.

Remarks:

Document groups provide a mechanism for categorising similar documents into a folder like structure. Document groups provide only a single level of grouping and are not hierarchical. Each IDocumentGroup includes a list of file extensions that are used to match each file to. The find_all_groups_for_extension and find_default_group_for_extension methods can be used to locate matching IDocumentGroup’s. 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.

Summary:

The number of items in this collection.

Returns:

The value of Count.

Return type:

count (int)

property supports_translations

Gets supports_translations.

Summary:

Determines if the IDocumentGroups support translation.

Returns:

The value of supports_translations.

Return type:

supports_translations (bool)

add(name)
Summary:

Add a new IDocumentGroup.

Parameters:

name (str) – The name to identify this document group.

Examples:

find_all_groups_for_extension(extension)
Summary:

Finds all IDocumentGroup’s that a file with the specified extension can be associated with.

Remarks:

The Extension can optionally include the period character and is case-insensitive.

Returns:

The result is a variant array of IDocumentGroup’s.

Parameters:

extension (str) – The file extension to locate the associated IDocumentGroup for.

Examples:

find_default_group_for_extension(extension)
Summary:

Finds the default IDocumentGroup that a file with the specified extension can be associated with.

Remarks:

The Extension can optionally include the period character and is case-insensitive. The first matching IDocumentGroup is located for the Extension specified. The groups are searched ordered by the Name property.

Parameters:

extension (str) – The file extension to locate the associated IDocumentGroup for.

Examples:

isNone()

Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.

item(index)
Summary:

Gets an IDocumentGroup object with the specified name or index.

Parameters:

index (any) – Specifies the index of the IDocumentGroup object to get.

refresh()
Summary:

Refresh the collection of IDocumentGroups directly from the document provider.

Examples