Scriptable object, inherited from IDocumentStructure

Document Read-Only object

Property Description
Binary Binary content property
Bookmarks Bookmark Collection
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
TabUsed Indicates that tabs are used in document
Title Document title
Version Content Version
Method Description
AbsoluteDistance Calculate absolute distance between text positions
AbsoluteToText Convert Absolute Position to Text Position
AdoptWhiteSpace Adopts white space in provided text to correspond the document settings
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
ForceJob Forces re-start of the specific job. nLineFrom = 0, nLineTo = -1 - process whole document
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
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
TextToAbsolute Convert Text Position to Absolute Position
TextToOffset Convert Text Position to Line Offset