IDocumentHistory¶

class IDocumentHistory¶

Bases: ImpactCOMWrapperBase, Iterable

Summary:: A collection of IDocumentHistoryItem objects.
Remarks:: Each operation performed on an IDocument creates a history item which can be used to keep track of changes made to the document.

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.

add(operation, details, version)¶

Summary:: Adds a new history item to a documents history.
Remarks:: The Operation number should be greater than 1000. Please contact Arden Software and they will allocate you a range of suitable numbers you can use. If you are adding your own history items to a document you should also consider implementing a document extender to provide string representations of each history operation. Contact Arden Software for information about creating a document extender. The IDatabase.application_name can be set to assign a value to the IDocumentHistoryItem.application as each history item is added. Introduced in Impact 9.0.0.83.

Parameters:

operation (int) – An operation number to identify the type of history item.
details (str) – The details of the history operation performed.
version (str) – An optional version for the history item.

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)¶

Parameters:: index (any) – Specifies the index of the history item to retrieve.

Examples