IBaseDocument [HippoEDIT Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== IBaseDocument ======
Scriptable object

===== Description =====
Base document interface

===== Properties =====
^Property^ Description^
|[[scripting:api:base-document:active-view|ActiveView]]| Returns active view of the document|
|[[scripting:api:base-document:bookmarks|Bookmarks]]| Bookmark Collection|
|[[scripting:api:base-document:can-redo|CanRedo]]| Checks if redo action possible|
|[[scripting:api:base-document:can-undo|CanUndo]]| Checks if undo action possible|
|[[scripting:api:base-document:changeable|Changeable]]| Changeable state of the document|
|[[scripting:api:base-document:data|Data]]| Binary Content of the document|
|[[scripting:api:base-document:locked|Locked]]| Locked state of the document|
|[[scripting:api:base-document:modified|Modified]]| Modified state of the document|
|[[scripting:api:base-document:path|Path]]| Path of the document|
|[[scripting:api:base-document:read-only|ReadOnly]]| Read-Only state of the document|
|[[scripting:api:base-document:title|Title]]| Title of the document|
|[[scripting:api:base-document:type|Type]]| Document Type|
|[[scripting:api:base-document:version|Version]]| Document version. Increased on every document change|
|[[scripting:api:base-document:views|Views]]| Returns document view collection|

===== Methods =====
^Method^ Description^
|[[scripting:api:base-document:close|Close]]| Closes the document|
|[[scripting:api:base-document:get-undo-item-description|GetUndoItemDescription]]| Returns description of Undo items|
|[[scripting:api:base-document:get-undo-items|GetUndoItems]]| Returns Undo Items List|
|[[scripting:api:base-document:get-undo-position|GetUndoPosition]]| Returns current Undo position|
|[[scripting:api:base-document:init|Init]]| Initialize the document, unloading/saving old one if needed|
|[[scripting:api:base-document:load|Load]]| Reloads the document from current path (source is empty), or loads from given path (source is string) or from stream (source is [[:scripting:api:stream:start|IStream]]). If bModifiedCheck set, use will be asked to confirm reload if changes exist|
|[[scripting:api:base-document:redo|Redo]]| Redo of the last editing steps until nNewPosition, if nNewPosition == -1 - until last begin of undo group|
|[[scripting:api:base-document:remove-bookmark|RemoveBookmark]]| Removes specific bookmark|
|[[scripting:api:base-document:reset-undo|ResetUndo]]| Resets Undo queue|
|[[scripting:api:base-document:save|Save]]| Saves document under given path. If path is empty saves on current file name|
|[[scripting:api:base-document:set-bookmark|SetBookmark]]| Sets bookmark on specific position|
|[[scripting:api:base-document:undo|Undo]]| Undo of the last editing steps until nNewPosition, if nNewPosition == -1 - until last begin of undo group|

===== See Also =====
[[:scripting:api:application:active-document|IApplication::ActiveDocument]], [[:scripting:api:application:get-document|IApplication::GetDocument]], [[:scripting:api:application:new-file-ex|IApplication::NewFileEx]], [[:scripting:api:application:open-file-ex|IApplication::OpenFileEx]], [[:scripting:api:base-documents:item|IBaseDocuments::Item]], [[:scripting:api:base-view:document|IBaseView::Document]], [[:scripting:api:marker:document|IBookmark::Document]], [[:scripting:api:document-base-events:on-document-loaded|IDocumentBaseEvents::onDocumentLoaded]], [[:scripting:api:document-base-events:on-document-open|IDocumentBaseEvents::onDocumentOpen]], [[:scripting:api:document-base-events:on-document-state-update|IDocumentBaseEvents::onDocumentStateUpdate]], [[:scripting:api:document-base-events:on-edit-operation|IDocumentBaseEvents::onEditOperation]], [[:scripting:api:document-base-events:on-modified-change|IDocumentBaseEvents::onModifiedChange]], [[:scripting:api:external-document:start|IExternalDocument]], [[:scripting:api:base-view:document|IExternalDocumentView::Document]], [[:scripting:api:frame-events:on-document-close|IFrameEvents::onDocumentClose]], [[:scripting:api:document-base-events:on-document-loaded|IFrameEvents::onDocumentLoaded]], [[:scripting:api:document-base-events:on-document-open|IFrameEvents::onDocumentOpen]], [[:scripting:api:frame-events:on-document-save|IFrameEvents::onDocumentSave]], [[:scripting:api:document-base-events:on-document-state-update|IFrameEvents::onDocumentStateUpdate]], [[:scripting:api:frame-events:on-document-switch|IFrameEvents::onDocumentSwitch]], [[:scripting:api:document-base-events:on-edit-operation|IFrameEvents::onEditOperation]], [[:scripting:api:document-base-events:on-modified-change|IFrameEvents::onModifiedChange]], [[:scripting:api:frame-events:on-new-document|IFrameEvents::onNewDocument]], [[:scripting:api:marker:document|IMarker::Document]], [[:scripting:api:application:active-document|IScriptApplication::ActiveDocument]], [[:scripting:api:application:get-document|IScriptApplication::GetDocument]], [[:scripting:api:application:new-file-ex|IScriptApplication::NewFileEx]], [[:scripting:api:application:open-file-ex|IScriptApplication::OpenFileEx]], [[:scripting:api:text-document:start|ITextDocument]], [[:scripting:api:base-view:document|ITextView::Document]]

#API
~~NOTOC~~