ITaskWindow

What it does

Represents the task window.

Methods

Definition Description
CloseDocument( document : IDocument )

Closes the document for editing from script.

When calling this method, the document state is changed.

CloseEditorWindow()

Closes the document editor.

Important! When closing the document editor, all unsaved changes will be lost.

When calling this method, the document state is changed.

CloseTask( bool ) Closes the task with a warning that the process will be canceled (if the argument is set to true) or without a warning (if the argument is set to false).
DocumentState( document : IDocument ) : TDocumentState

Retrieves the document state in the task window.

Note: The method cannot be invoked from a secondary thread.

EditDocument( document : IDocument, page : IPage ) : IDocumentEditor

Opens the document in the document editor for editing.

Note: If the document is opened successfully, the object of the IDocumentEditor type is returned. Otherwise null is returned.

When calling this method, the document state is changed.

OpenDocument( document : IDocument )

Opens the document for editing from script. The method can be called even when the document is opened in the document editor with read-only permissions.

When calling this method, the document state is changed.

RejectTask( bool ) Rejects the task with a warning that the process will be canceled (if the argument is set to true) or without a warning (if the argument is set to false).

Properties

Name Type Access Description
Batch IBatch Read-only The batch
DocumentsWindow IDocumentsWindow Read-only The documents window
EditorWindow IDocumentEditor Read-only The document editor
Handle int Read-only The handle of the window
MainWindow IMainWindow Read-only The main window
Mode TTaskWindowMode Read/write The view mode

11/10/2020 12:08:04 PM


Please leave your feedback about this article