IExternalDocument
Scriptable object, inherited from IBaseDocument
Description
External document interface to be implemented (optionally) by File Handler plugins
Properties
| Property | Description |
|---|---|
| ActiveView | Returns active view of the document |
| Bookmarks | Bookmark Collection |
| CanRedo | Checks if redo action possible |
| CanUndo | Checks if undo action possible |
| Changeable | Changeable state of the document |
| Data | Binary Content of the document |
| Locked | Locked state of the document |
| Modified | Modified state of the document |
| Path | Path of the document |
| Plugin | Return owning plugin |
| ReadOnly | Read-Only state of the document |
| Title | Title of the document |
| Type | Document Type |
| Version | Document version. Increased on every document change |
| Views | Returns document view collection |
Methods
| Method | Description |
|---|---|
| Close | Closes the document |
| CreateView | Returns view for drawing |
| GetUndoItemDescription | Returns description of Undo items |
| GetUndoItems | Returns Undo Items List |
| GetUndoPosition | Returns current Undo position |
| Init | Initialize the document, unloading/saving old one if needed |
| Load | Reloads the document from current path (source is empty), or loads from given path (source is string) or from stream (source is IStream). If bModifiedCheck set, use will be asked to confirm reload if changes exist |
| LoadInfo | Called when document preferences shall to be loaded from workspace |
| Redo | Redo of the last editing steps until nNewPosition, if nNewPosition == -1 - until last begin of undo group |
| RemoveBookmark | Removes specific bookmark |
| ResetUndo | Resets Undo queue |
| Save | Saves document under given path. If path is empty saves on current file name |
| SaveInfo | Called when document preferences shall to be stored in workspace |
| SetBookmark | Sets bookmark on specific position |
| Undo | Undo of the last editing steps until nNewPosition, if nNewPosition == -1 - until last begin of undo group |