Collapse All Expand All Code: All Code: Multiple Code: C# Code: Visual Basic Members: Show All Members: Filtered Members: Filtered Members: Filtered

C#
Visual Basic
Include Protected Members
Include Inherited Members

Azuki 1.7 Documentation
Document Members
Document Class Constructors Methods Properties Events See Also Send Feedback

The Document type exposes the following members.

# Constructors

| Name | Description
--- | --- | ---
| Document | Creates a new instance.

# Methods

| Name | Description
--- | --- | ---
| BeginUndo | Begins grouping up editing actions into a single UNDO action.
| ClearHistory | Clears all stacked edit histories.
| EndUndo | Ends grouping up editing actions.
| FindMatchedBracket(Int32) | Finds matched bracket from specified index.
| FindMatchedBracket(Int32, Int32) | Finds matched bracket from specified index.
| FindNext(String, Int32) | Finds a text pattern.
| FindNext(Regex, Int32) | Finds a text pattern by regular expression.
| FindNext(String, Int32, Boolean) | Finds a text pattern.
| FindNext(String, Int32, Int32) | Finds a text pattern.
| FindNext(Regex, Int32, Int32) | Finds a text pattern by regular expression.
| FindNext(String, Int32, Int32, Boolean) | Finds a text pattern.
| FindPrev(String, Int32) | Finds a text pattern backward.
| FindPrev(Regex, Int32) | Finds a text pattern backward by regular expression.
| FindPrev(String, Int32, Boolean) | Finds a text pattern backward.
| FindPrev(String, Int32, Int32) | Finds a text pattern backward.
| FindPrev(Regex, Int32, Int32) | Finds a text pattern backward by regular expression.
| FindPrev(String, Int32, Int32, Boolean) | Finds a text pattern backward.
| GetCaretIndex | Gets caret location by logical line/column index.
| GetCharAt | Gets a character at specified index.
| GetCharClass | Gets class of the character at given index.
| GetCharIndexFromLineColumnIndex | Calculates char-index from logical line/column index.
| GetEnumerator | Gets content enumerator.
| GetLineColumnIndexFromCharIndex | Calculates logical line/column index from char-index.
| GetLineContent | Gets content of the logical line.
| GetLineContentWithEolCode | Gets content of the logical line without trimming EOL code.
| GetLineDirtyState | Gets dirty state of specified line.
| GetLineEndIndexFromCharIndex | Gets index of the end position of the line which contains a character at the specified index.
| GetLineHeadIndex | Gets index of the first character in specified logical line.
| GetLineHeadIndexFromCharIndex | Gets index of the first char in the logical line which contains the specified char-index.
| GetLineIndexFromCharIndex | Calculates logical line index from char-index.
| GetLineLength(Int32) | Gets length of the logical line.
| GetLineLength(Int32, Boolean) | Gets length of the logical line.
| GetLineLengthFromCharIndex(Int32) | Gets length of the logical line which contains the specified char-index.
| GetLineLengthFromCharIndex(Int32, Boolean) | Gets length of the logical line which contains the specified char-index.
| GetMarkedRange | Gets range of text part which includes specified index which is marked with specified ID.
| GetMarkedText | Gets text part marked with specified ID at specified index.
| GetMarkingBitMaskAt | Gets marking IDs at specified index as a bit mask (internal representation).
| GetMarkingsAt | List up all markings at specified index and returns their IDs as an array.
| GetSelection | Gets range of current selection. Note that this method does not return [anchor, caret) pair but [begin, end) pair.
| GetTextInRange(Int32, Int32) | Gets text in the range [begin, end).
| GetTextInRange(Int32, Int32, Int32, Int32) | Gets text in the range [ (fromLineIndex, fromColumnIndex), (toLineIndex, toColumnIndex) ).
| GetTextInRangeRef | Gets text in the range [begin, end).
| GetWordAt(Int32) | Gets a word at specified index.
| GetWordAt(Int32, Int32%, Int32%) | Gets a word at specified index.
| IsCDATA | Gets whether the character at specified index is just a data without meaning on grammar.
| IsCombiningCharacter(Char) | Determines whether given character is a combining character or not.
| IsCombiningCharacter(Int32) | Determines whether given character is a combining character or not.
| IsCombiningCharacter(String, Int32) | Determines whether given character is a combining character or not.
| IsHighSurrogate | Determines whether given char is a high surrogate or not.
| IsLowSurrogate | Determines whether given char is a low surrogate or not.
| IsMarked | Determine whether specified index is marked with specified marking ID or not.
| IsNotDividableIndex(Int32) | Determines whether text should not be divided at given index or not.
| IsNotDividableIndex(String, Int32) | Determines whether text should not be divided at given index or not.
| Mark | Marks up specified text range.
| NextGraphemeClusterIndex | Gets index of next grapheme cluster.
| PrevGraphemeClusterIndex | Gets index of previous grapheme cluster.
| Redo | Executes REDO.
| Replace(String) | Replaces current selection.
| Replace(String, Int32, Int32) | Replaces specified range [begin, end) of the content into the given string.
| SetCaretIndex | Sets caret location by logical line/column index. Note that calling this method will release selection.
| SetCharClass | Sets class of the character at given index.
| SetSelection(Int32, Int32) | Sets selection range.
| SetSelection(Int32, Int32, IView) | Sets selection range.
| Undo | Executes UNDO.
| Unmark | Removes specified type of marking information at specified range.

# Properties

| Name | Description
--- | --- | ---
| AnchorIndex | Gets index of the position where the selection starts (in char-index).
| CanRedo | Gets whether an available REDO action exists or not.
| CanUndo | Gets whether an available UNDO action exists or not.
| Capacity | Gets or sets the size of the internal buffer.
| CaretIndex | Gets index of where the caret is at (in char-index).
| EolCode | Gets or sets default EOL Code of this document.
| Highlighter | Gets or sets highlighter object to highlight currently active document or null to disable highlighting.
| IsDirty | Gets or sets whether any unsaved modifications exist or not.
| IsReadOnly | Gets or sets whether this document is read-only or not.
| IsRecordingHistory | Gets or sets whether this document is recording edit actions or not.
| Item | Gets one character at given index.
| LastModifiedTime | Gets the time when this document was last modified.
| Length | Gets number of characters currently held in this document. Note that a surrogate pair or combining characters will be counted as two characters.
| LineCount | Gets number of the logical lines.
| MarksUri | Gets or sets whether URIs in this document should be marked automatically with built-in URI marker or not.
| MemoryUsage | Gets estimated memory size used by this document.
| RectSelectRanges | Gets or sets text ranges selected by rectangle selection.
| SelectionMode | Gets or sets how to select text.
| Tag | Gets or sets an object associated with this document.
| Text | Gets or sets currently inputted text.
| WatchPatterns | Gets the list of watching patterns.
| WordProc | Gets or sets word processor object which determines how Azuki handles 'words.'

# Events

| Name | Description
--- | --- | ---
| ContentChanged | Occurs when the document content was changed. ContentChangedEventArgs contains the old (replaced) text, new text, and index indicating the replacement occured.
| DirtyStateChanged | Occurs when IsDirty property has changed.
| SelectionChanged | Occurs when the selection was changed.
| SelectionModeChanged | Occures soon after selection mode was changed.

# See Also

Document Class
Sgry.Azuki Namespace