IDocument

Scriptable object, inherited from IDocumentData

Editable Document object

Property Description
ActiveView Returns active view of the document
AutoReload Document Auto-Reload property
Binary Binary content property
Bookmarks Bookmark Collection
CanRedo Checks if redo action possible
CanUndo Checks if undo action possible
EmbeddedScopes Embedded styles
Encoding Document encoding
IndentSize Return default indent for document
LabelDataValid True if label data is valid
Labels Labels collection
LineBreak Default Line Break Style
LineCount Line count property
Markers Markers Collection
MaxLineLength Return maximum line length
Modified Modified state
NotClosedScopes Not Closed Scopes collection
NotOpenScopes Not Open Scopes collection
OverviewScopes Embedded styles
Path Document file path
ReadOnly Read-Only state
ScopeDataValid True if scope data is valid
ScopeDataVersion Scope data version
Scopes Scopes collection
Size Return document size in characters
Slow Slow document property
Syntax Document active syntax property
TabSize Document Tab Size
TabUsed Indicates that tabs are used in document
Title Document title
Version Content Version
Views Returns document view collection
Method Description
AbsoluteDistance Calculate absolute distance between text positions
AbsoluteToText Convert Absolute Position to Text Position
Activate Activates the document
AddMarker Add new marker to the document
AddStyleRange Add Style Range
AdoptIndent Adopts indentation of selected range to fit desired level
AdoptWhiteSpace Adopts white space in provided text to correspond the document settings
append Appends text to the end of document
appendln Appends text and new line to the end of document
BeginUndoGroup Start undo group or merge with previous
Close Closes the document
DeleteText Deletes text from specific range
DeleteTextBlock Deletes text from specific range in Block Mode
DisableBookmark Disables bookmark for specific line
equals Compare, if objects are equal
Find Finds text in the document
FindAll Finds all matches text in the document
FindLabel Find Label from point
FindLabels Find Labels from range
FindScope Find Scope from point
FindScopes Find Scopes from range
FlushUndoGroup Flush last undo group
ForceJob Forces re-start of the specific job. nLineFrom = 0, nLineTo = -1 - process whole document
GetBookmark Reads bookmark from specific line
GetChar Returns the character to the right of the position (absolute)
GetDesiredLineIndent Returns desired line indent
GetLine Returns copy of document line chars
GetLineActualLength Returns line actual (expanded tabs) length
GetLineBreak Returns line break chars
GetLineLength Returns line length
GetLines Returns lines of range
GetStyleFromPos Returns top style with ranges from position
GetStylesFromPos Returns style stack from position
GetText Returns copy of text
InsertText Inserts text in specific position
InsertTextBlock Inserts text in specific position in Block Mode
InsertUndoRecord Insert abstract undo step for informing registered listener
IsJobRunning Checks if specific is still running (so its results are not up-to-date)
IsKnownTerm Check, if word exist in document, using statistic data
IsLineHidden Returns true, if line is hidden (inside of collapsed area)
IsLineModified Returns true, if line has been modified
IsLineSaved Returns true, if line has been modified and saved
IsProtected Check, if document point inside of protected area
MovePosition Moves position
MovePositionLine Moves position line
OffsetToText Convert Line Offset to Text Position
ProtectLine Mark line as protected
Redo Redo of the last editing steps until nNewPosition, if nNewPosition == -1 - until last begin of undo group
Reload Reloads the document or from original path (strPath empty), or from given path. If bModifiedCheck set, use will be asked to confirm reload
RemoveMarkers Removes markers from the document or by marker reference or by range
RemoveStyleRanges Remove Style Ranges
ReplaceText Replace text in specific range
ResetUndo Reset Undo queue
Save Saves the document
SetBookmark Sets bookmark for specific line
TextToAbsolute Convert Text Position to Absolute Position
TextToOffset Convert Text Position to Line Offset
Undo Undo of the last editing steps until nNewPosition, if nNewPosition == -1 - until last begin of undo group
Update Updates all connected views, cleaning all buffers from line nLine
write Inserts or overwrites a string at the current cursor position
writeln Inserts or overwrites a string and a new line at the current cursor position