ICSharpCode.AvalonEdit

Custom commands for AvalonEdit.

Converts leading spaces to tabs in the selected lines (or the whole document if the selection is empty).

Converts leading tabs to spaces in the selected lines (or the whole document if the selection is empty).

Converts spaces to tabs in the selected text.

Converts tabs to spaces in the selected text.

Converts the selected text to lower case.

Converts the selected text to title case.

Converts the selected text to upper case.

Deletes the current line. The default shortcut is Ctrl+D.

Runs the IIndentationStrategy on the selected lines (or the whole document if the selection is empty).

Inverts the case of the selected text.

Removes leading whitespace from the selected lines (or the whole document if the selection is empty).

Removes trailing whitespace from the selected lines (or the whole document if the selection is empty).

Represents a text editor control (, or ).

Gets the document being edited.

Occurs when the Document property changes (when the text editor is connected to another document - not when the document content changes).

Occurs when the Options property changes, or when an option inside the current option list changes.

Gets the options of the text editor.

The text editor control. Contains a scrollable TextArea.

Creates a new TextEditor instance.

Appends text to the end of the document.

Begins a group of document changes.

Gets if the most recent undone command can be redone.

Gets if the most recent command can be undone.

Gets/sets the caret position.

Clears the text.

Copies the current selection to the clipboard.

Creates the highlighting colorizer for the specified highlighting definition. Allows derived classes to provide custom colorizer implementations for special highlighting definitions.

Removes the current selection and copies it to the clipboard.

Begins a group of document changes and returns an object that ends the group of document changes when it is disposed.

Gets/Sets the document displayed by the text editor. This is a dependency property.

Occurs when the document property has changed.

Document property.

Gets/sets the encoding used when the file is saved.

Encoding dependency property.

Ends the current group of document changes.

Gets the vertical size of the document.

Gets the horizontal size of the current document region.

Gets the text view position from a point inside the editor.

The position, relative to top left corner of TextEditor control The text view position, or null if the point is outside the document.

Gets the horizontal scroll position.

Gets/Sets the horizontal scroll bar visibility.

Dependency property for

Gets/Sets the 'modified' flag.

Dependency property for

Specifies whether the user can change the text editor content. Setting this property will replace the TextArea.ReadOnlySectionProvider.

IsReadOnly dependency property.

Gets the number of lines in the document.

Scrolls one line down.

Scrolls to the left.

Gets/sets the Brush used for displaying the foreground color of line numbers.

LineNumbersForeground dependency property.

Scrolls to the right.

Scrolls one line up.

Loads the text from the stream, auto-detecting the encoding.

Occurs when the mouse has hovered over a fixed location for some time.

The MouseHover event.

Occurs when the mouse had previously hovered but now started moving again.

The MouseHoverStopped event.

Is called after the template was applied.

Returns class-specific implementations for the Windows Presentation Foundation (WPF) infrastructure.

The type-specific implementation.

Raises the event.

Invoked when an unhandled attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

The that contains the event data.

Raises the event.

Occurs when a text editor option has changed.

Gets/Sets the options currently used by the text editor.

Options property.

Scrolls one page down.

Scrolls one page left.

Scrolls one page right.

Scrolls one page up.

Pastes the clipboard content.

Occurs when the mouse has hovered over a fixed location for some time.

The PreviewMouseHover event.

Occurs when the mouse had previously hovered but now started moving again.

The PreviewMouseHoverStopped event.

Receives events from the centralized event manager.

The type of the calling this method. Object that originated the event. Event data. true if the listener handled the event. It is considered an error by the handling in WPF to register a listener for an event that the listener does not handle. Regardless, the method should return false if it receives an event that it does not recognize or handle.

Redoes the most recent undone command.

True is the redo operation was successful, false is the redo stack is empty.

Saves the text to the stream.

Saves the text to the file.

Scrolls to the specified line/column. This method requires that the TextEditor was already assigned a size (WPF layout must have run prior).

Scrolls to the end of the document.

Scrolls to the start of the document.

Scrolls to the specified position in the document.

Scrolls to the specified line. This method requires that the TextEditor was already assigned a size (WPF layout must have run prior).

Scrolls to the specified position in the document.

Selects the specified text section.

Selects the entire text.

Gets/Sets the selected text.

Gets/sets the length of the selection.

Gets/sets the start position of the selection.

Specifies whether line numbers are shown on the left to the text view.

ShowLineNumbers dependency property.

Gets/sets the syntax highlighting definition used to colorize the text.

The property.

Gets/Sets the text of the current document.

Gets the text area.

Occurs when the Text property changes.

Undoes the most recent command.

True is the undo operation was successful, false is the undo stack is empty.

Gets the vertical scroll position.

Gets/Sets the vertical scroll bar visibility.

Dependency property for

Gets the horizontal size of the viewport.

Specifies whether the text editor uses word wrapping.

Word wrap dependency property.

Exposes to automation.

Creates a new TextEditorAutomationPeer instance.

Gets the control pattern for the that is associated with this .

A value from the enumeration. An object that implements the interface if is ; otherwise, null.

A container for the text editor options.

Initializes an empty instance of TextEditorOptions.

Initializes a new instance of TextEditorOptions by copying all values from to the new instance.

Gets/Sets whether the user can scroll below the bottom of the document. The default value is false; but it a good idea to set this property to true when using folding.

Gets/Sets if the user is allowed to enable/disable overstrike mode.

Gets/Sets where the column ruler should be shown.

Gets/Sets whether to use spaces for indentation instead of tabs.

Gets/Sets whether copying without a selection copies the whole current line.

Gets/Sets whether to enable clickable hyperlinks for e-mail addresses in the editor.

Gets/Sets whether to enable clickable hyperlinks in the editor.

Gets/Sets whether the support for Input Method Editors (IME) for non-alphanumeric scripts (Chinese, Japanese, Korean, ...) is enabled.

Enables rectangular selection (press ALT and select a rectangle)

Enable dragging text within the text area.

Gets/Sets whether the user can set the caret behind the line ending (into "virtual space"). Note that virtual space is always used (independent from this setting) when doing rectangle selections.

Gets text required to indent from the specified to the next indentation level.

Gets/Sets if mouse cursor should be hidden while user is typing.

Gets/Sets if current line should be shown.

Gets/Sets the width of one indentation unit.

Gets the text used for indentation.

Gets/Sets whether the indentation is inherited from the first line when word-wrapping. The default value is true.

Raises the PropertyChanged event.

The name of the changed property.

Occurs when a property value changes.

Gets/Sets whether the user needs to press Control to click hyperlinks. The default value is true.

Gets/Sets whether to show a box with the hex code for control characters.

Gets/Sets whether the column ruler should be shown.

Gets/Sets whether to show ¶ at the end of lines.

Gets/Sets whether to show · for spaces.

Gets/Sets whether to show » for tabs.

Gets/Sets the indentation used for all lines except the first when word-wrapping. The default value is 0.

Contains weak event managers for .

Weak event manager for the event.

ICSharpCode.AvalonEdit.TextEditorWeakEventManager.DocumentChanged

Weak event manager for the event.

ICSharpCode.AvalonEdit.TextEditorWeakEventManager.OptionChanged

Represents a text location with a visual column.

ICSharpCode.AvalonEdit.TextViewPosition

Creates a new TextViewPosition instance.

Gets/Sets the (text) column number.

Compares the current object with another object of the same type.

An object to compare with this object. A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the parameter.Zero This object is equal to . Greater than zero This object is greater than .

Equality test.

Indicates whether this instance and a specified object are equal.

Another object to compare to. true if and this instance are the same type and represent the same value; otherwise, false.

Returns the hash code for this instance.

A 32-bit signed integer that is the hash code for this instance.

When word-wrap is enabled and a line is wrapped at a position where there is no space character; then both the end of the first TextLine and the beginning of the second TextLine refer to the same position in the document, and also have the same visual column. In this case, the IsAtEndOfLine property is used to distinguish between the two cases: the value true indicates that the position refers to the end of the previous TextLine; the value false indicates that the position refers to the beginning of the next TextLine. If this position is not at such a wrapping position, the value of this property has no effect.

Gets/Sets the line number.

Gets/Sets Location.

Equality test.

Inequality test.

Returns the fully qualified type name of this instance.

A containing a fully qualified type name.

Gets/Sets the visual column number. Can be -1 (meaning unknown visual column).

The listbox used inside the CompletionWindow, contains CompletionListBox.

ICSharpCode.AvalonEdit.CodeCompletion.CompletionList

Gets the list to which completion data can be added.

Content of EmptyTemplate will be shown when CompletionList contains no items. If EmptyTemplate is null, nothing will be shown.

Dependency property for .

Handles a key press. Used to let the completion list handle key presses while the focus is still on the text editor.

Is raised when the completion list indicates that the user has chosen an entry to be completed.

If true, the CompletionList is filtered to show only matching items. Also enables search by substring. If false, enables the old behavior: no filtering, search by string.StartsWith.

Gets the list box.

When overridden in a derived class, is invoked whenever application code or internal processes call .

Invoked when an unhandled attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

The that contains the event data.

Raises the routed event.

The event data.

Raises the InsertionRequested event.

Gets the scroll viewer used in this list box.

Gets/Sets the selected item.

Occurs when the SelectedItem property changes.

Selects the best match, and filter the items if turned on using .

The list box used inside the CompletionList.

ICSharpCode.AvalonEdit.CodeCompletion.CompletionListBox

Centers the view on the item with the specified index.

Removes the selection.

Gets the number of the first visible item.

When overridden in a derived class, is invoked whenever application code or internal processes call .

Selects the item with the specified index and scrolls it into view.

Gets the number of visible items.

The code completion window.

Creates a new code completion window.

Gets/Sets whether the completion window should close automatically. The default value is true.

Gets whether the completion window should automatically close when the text editor looses focus.

When this flag is set, code completion closes if the caret moves to the beginning of the allowed range. This is useful in Ctrl+Space and "complete when typing", but not in dot-completion. Has no effect if CloseAutomatically is false.

Gets the completion list used in this completion window.

Detaches events from the text area.

Raises the event.

An that contains the event data.

Invoked when an unhandled attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

The that contains the event data.

Base class for completion windows. Handles positioning the window at the caret.

Creates a new CompletionWindowBase.

Activates the parent window.

Gets whether the completion window should automatically close when the text editor looses focus.

Detaches events from the text area.

Gets/Sets the end of the text range in which the completion window stays open. This text portion is used to determine the text used to select an entry in the completion list by typing.

Gets/sets whether the completion window should expect text insertion at the start offset, which not go into the completion region, but before it.

Gets whether the window was opened above the current line.

Raises the event.

An that contains the event data.

Raises the event.

An that contains the event data.

Invoked when an unhandled attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

The that contains the event data.

Raises the event, using the specified information as part of the eventual event data.

Details of the old and new size involved in the change.

Raises the event.

An that contains the event data.

Raises a tunnel/bubble event pair for a WPF control.

The WPF control for which the event should be raised. The tunneling event. The bubbling event. The event args to use. The value of the event args.

Positions the completion window at the specified position.

Gets/Sets the start of the text range in which the completion window stays open. This text portion is used to determine the text used to select an entry in the completion list by typing.

Gets the parent TextArea.

Updates the position of the CompletionWindow based on the parent TextView position and the screen working area. It ensures that the CompletionWindow is completely visible on the screen.

Describes an entry in the .

summary M:ICSharpCode.AvalonEdit.CodeCompletion.ICompletionData.Complete(ICSharpCode.AvalonEdit.Editing.TextArea,ICSharpCode.NRefactory.Editor.ISegment,System.EventArgs)

The displayed content. This can be the same as 'Text', or a WPF UIElement if you want to display rich content.

Gets the description.

Gets the image.

Gets the priority. This property is used in the selection logic. You can use it to prefer selecting those items which the user is accessing most frequently.

Gets the text. This property is used to filter the list of visible elements.

A popup-like window that is attached to a text segment.

Creates a new InsightWindow.

Gets/Sets whether the insight window should close automatically. The default value is true.

Gets whether the completion window should automatically close when the text editor looses focus.

Detaches events from the text area.

Raises the event.

An that contains the event data.

Provides the items for the OverloadViewer.

Gets the number of overloads.

Gets the current content.

Gets the current header.

Gets the text 'SelectedIndex of Count'.

Gets/Sets the selected index.

Insight window that shows an OverloadViewer.

Creates a new OverloadInsightWindow.

Invoked when an unhandled attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

The that contains the event data.

Gets/Sets the item provider.

Represents a text between "Up" and "Down" buttons.

ICSharpCode.AvalonEdit.CodeCompletion.OverloadViewer

Changes the selected index.

The relative index change - usual values are +1 or -1.

When overridden in a derived class, is invoked whenever application code or internal processes call .

Gets/Sets the item provider.

The ItemProvider property.

Gets/Sets the text between the Up and Down buttons.

The text property.

A segment using s as start and end positions.

Creates a new AnchorSegment using the specified anchors. The anchors must have set to true.

ICSharpCode.AvalonEdit.Document.AnchorSegment

Creates a new AnchorSegment that creates new anchors.

summary P:ICSharpCode.AvalonEdit.Document.AnchorSegment.EndOffset

summary P:ICSharpCode.AvalonEdit.Document.AnchorSegment.Length

summary P:ICSharpCode.AvalonEdit.Document.AnchorSegment.Offset

Returns a that represents the current .

A that represents the current .

Specifies the mode for getting the next caret position.

Normal positioning (stop after every grapheme)

Stop only on word borders.

Stop only at the beginning of words. This is used for Ctrl+Left/Ctrl+Right.

Stop only at the beginning of words, and anywhere in the middle of symbols.

Stop only on word borders, and anywhere in the middle of symbols.

Stop between every Unicode codepoint, even within the same grapheme. This is used to implement deleting the previous grapheme when Backspace is pressed.

Classifies a character as whitespace, line terminator, part of an identifier, or other.

The character is not whitespace, line terminator or part of an identifier.

The character is whitespace (but not line terminator).

The character can be part of an identifier (Letter, digit or underscore).

The character is line terminator (\r or \n).

The character is a unicode combining mark that modifies the previous character. Corresponds to the Unicode designations "Mn", "Mc" and "Me".

Describes a change of the document text. This class is thread-safe.

ICSharpCode.AvalonEdit.Document.DocumentChangeEventArgs

Creates a new DocumentChangeEventArgs object.

summary M:ICSharpCode.AvalonEdit.Document.DocumentChangeEventArgs.GetNewOffset(System.Int32,ICSharpCode.NRefactory.Editor.AnchorMovementType)

summary M:ICSharpCode.AvalonEdit.Document.DocumentChangeEventArgs.Invert

Gets the OffsetChangeMap associated with this document change.

Represents a line inside a .

Gets the length of the line delimiter. The value is 1 for single "\r" or "\n", 2 for the "\r\n" sequence; and 0 for the last line in the document.

Gets the end offset of the line in the document's text (the offset before the line delimiter). Runtime: O(log n)

The line was deleted.

Gets if this line was deleted from the document.

Gets the length of this line. The length does not include the line delimiter. O(1)

Gets the number of this line. Runtime: O(log n)

The line was deleted.

Gets the next line in the document.

The line following this line, or null if this is the last line.

Gets the starting offset of the line in the document's text. Runtime: O(log n)

The line was deleted.

Gets the previous line in the document.

The line before this line, or null if this is the first line.

Gets a string with debug output showing the line number and offset. Does not include the line's text.

Gets the length of this line, including the line delimiter. O(1)

A TextWriter implementation that directly inserts into a document.

ICSharpCode.AvalonEdit.Document.DocumentTextWriter

When overridden in a derived class, returns the in which the output is written.

The Encoding in which the output is written.

Gets/Sets the current insertion offset.

Writes a character to the text stream.

The character to write to the text stream. The is closed. An I/O error occurs.

Writes a subarray of characters to the text stream.

The character array to write data from. Starting index in the buffer. The number of characters to write. The buffer length minus is less than . The parameter is null. or is negative. The is closed. An I/O error occurs.

Writes a string to the text stream.

The string to write. The is closed. An I/O error occurs.

Allows for low-level line tracking.

Is called immediately before a document line is removed.

Notifies the line tracker that a document change (a single change, not a change group) has completed. This method gets called after the change has been performed, but before the event is raised.

Is called immediately after a line was inserted.

The new line The existing line before the new line

Indicates that there were changes to the document that the line tracker was not notified of. The document is in a consistent state (but the line trackers aren't), and line trackers should throw away their data and rebuild the document.

Is called immediately before a document line changes length. This method will be called whenever the line is changed, even when the length stays as it is. The method might be called multiple times for a single line because a replacement is internally handled as removal followed by insertion.

This Interface describes a the basic Undo/Redo operation all Undo Operations must implement this interface.

Redo the last operation

Undo the last operation

Describes a series of offset changes.

Creates a new OffsetChangeMap instance.

Immutable OffsetChangeMap that is empty.

Freezes this instance.

Creates a new OffsetChangeMap with a single element.

The entry. Returns a frozen OffsetChangeMap with a single entry.

summary M:ICSharpCode.AvalonEdit.Document.OffsetChangeMap.GetNewOffset(System.Int32,ICSharpCode.NRefactory.Editor.AnchorMovementType)

Calculates the inverted OffsetChangeMap (used for the undo operation).

Gets if this instance is frozen. Frozen instances are immutable and thus thread-safe.

Gets whether this OffsetChangeMap is a valid explanation for the specified document change.

An entry in the OffsetChangeMap. This represents the offset of a document change (either insertion or removal, not both at once).

Creates a new OffsetChangeMapEntry instance.

Gets whether default anchor movement causes the anchor to stay in front of the caret.

Indicates whether the current object is equal to another object of the same type.

An object to compare with this object. true if the current object is equal to the parameter; otherwise, false.

Indicates whether this instance and a specified object are equal.

Another object to compare to. true if and this instance are the same type and represent the same value; otherwise, false.

Returns the hash code for this instance.

A 32-bit signed integer that is the hash code for this instance.

summary M:ICSharpCode.AvalonEdit.Document.OffsetChangeMapEntry.GetNewOffset(System.Int32,ICSharpCode.NRefactory.Editor.AnchorMovementType)

The number of characters inserted. Returns 0 if this entry represents a removal.

The offset at which the change occurs.

Tests the two entries for equality.

Tests the two entries for inequality.

The number of characters removed. Returns 0 if this entry represents an insertion.

Gets whether the removal should not cause any anchor deletions.

Contains predefined offset change mapping types.

Normal replace. Anchors in front of the replaced region will stay in front, anchors after the replaced region will stay after. Anchors in the middle of the removed region will be deleted. If they survive deletion, they move depending on their AnchorMovementType.

First the old text is removed, then the new text is inserted. Anchors immediately in front (or after) the replaced region may move to the other side of the insertion, depending on the AnchorMovementType.

The text is replaced character-by-character. Anchors keep their position inside the replaced text. Anchors after the replaced region will move accordingly if the replacement text has a different length than the replaced text. If the new text is shorter than the old text, anchors inside the old text that would end up behind the replacement text will be moved so that they point to the end of the replacement text.

Like 'Normal', but anchors with = Default will stay in front of the insertion instead of being moved behind it.

Implements the ITextSource interface using a rope.

Creates a new RopeTextSource.

ICSharpCode.AvalonEdit.Document.RopeTextSource

summary M:ICSharpCode.AvalonEdit.Document.RopeTextSource.CreateReader

summary M:ICSharpCode.AvalonEdit.Document.RopeTextSource.CreateReader(System.Int32,System.Int32)

summary M:ICSharpCode.AvalonEdit.Document.RopeTextSource.CreateSnapshot

summary M:ICSharpCode.AvalonEdit.Document.RopeTextSource.CreateSnapshot(System.Int32,System.Int32)

summary M:ICSharpCode.AvalonEdit.Document.RopeTextSource.GetCharAt(System.Int32)

Returns a clone of the rope used for this text source.

summary M:ICSharpCode.AvalonEdit.Document.RopeTextSource.GetText(ICSharpCode.NRefactory.Editor.ISegment)

summary M:ICSharpCode.AvalonEdit.Document.RopeTextSource.GetText(System.Int32,System.Int32)

summary M:ICSharpCode.AvalonEdit.Document.RopeTextSource.IndexOf(System.Char,System.Int32,System.Int32)

summary M:ICSharpCode.AvalonEdit.Document.RopeTextSource.IndexOf(System.String,System.Int32,System.Int32,System.StringComparison)

summary M:ICSharpCode.AvalonEdit.Document.RopeTextSource.IndexOfAny(System.Char[],System.Int32,System.Int32)

summary M:ICSharpCode.AvalonEdit.Document.RopeTextSource.LastIndexOf(System.Char,System.Int32,System.Int32)

summary M:ICSharpCode.AvalonEdit.Document.RopeTextSource.LastIndexOf(System.String,System.Int32,System.Int32,System.StringComparison)

summary P:ICSharpCode.AvalonEdit.Document.RopeTextSource.Text

summary P:ICSharpCode.AvalonEdit.Document.RopeTextSource.TextLength

summary P:ICSharpCode.AvalonEdit.Document.RopeTextSource.Version

summary M:ICSharpCode.AvalonEdit.Document.RopeTextSource.WriteTextTo(System.IO.TextWriter)

summary M:ICSharpCode.AvalonEdit.Document.RopeTextSource.WriteTextTo(System.IO.TextWriter,System.Int32,System.Int32)

The TextAnchor class references an offset (a position between two characters). It automatically updates the offset when text is inserted/removed in front of the anchor.

Gets the column number of this anchor.

Thrown when trying to get the Offset from a deleted anchor.

summary E:ICSharpCode.AvalonEdit.Document.TextAnchor.Deleted

Gets the document owning the anchor.

summary P:ICSharpCode.AvalonEdit.Document.TextAnchor.IsDeleted

Gets the line number of the anchor.

Thrown when trying to get the Offset from a deleted anchor.

Gets the text location of this anchor.

Thrown when trying to get the Offset from a deleted anchor.

summary P:ICSharpCode.AvalonEdit.Document.TextAnchor.MovementType

Gets the offset of the text anchor.

Thrown when trying to get the Offset from a deleted anchor.

summary P:ICSharpCode.AvalonEdit.Document.TextAnchor.SurviveDeletion

Returns a that represents the current .

A that represents the current .

This class is the main class of the text model. Basically, it is a with events.

Create an empty text document.

ICSharpCode.AvalonEdit.Document.TextDocument

Create a new text document with the specified initial text.

Begins a group of document changes. Some events are suspended until EndUpdate is called, and the will group all changes into a single action. Calling BeginUpdate several times increments a counter, only after the appropriate number of EndUpdate calls the events resume their work.

Is raised after the document has changed.

Is raised before the document changes.

Creates a new at the specified offset.

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.CreateDocumentSnapshot

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.CreateReader

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.CreateReader(System.Int32,System.Int32)

Creates a snapshot of the current text.

Creates a snapshot of a part of the current text.

Ends a group of document changes.

summary P:ICSharpCode.AvalonEdit.Document.TextDocument.FileName

summary E:ICSharpCode.AvalonEdit.Document.TextDocument.FileNameChanged

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.GetCharAt(System.Int32)

Gets a line by the line number: O(log n)

Gets a document lines by offset. Runtime: O(log n)

Gets the location from an offset.

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.GetOffset(ICSharpCode.NRefactory.TextLocation)

Gets the offset from a text location.

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.GetText(ICSharpCode.NRefactory.Editor.ISegment)

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.GetText(System.Int32,System.Int32)

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.IndexOf(System.Char,System.Int32,System.Int32)

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.IndexOf(System.String,System.Int32,System.Int32,System.StringComparison)

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.IndexOfAny(System.Char[],System.Int32,System.Int32)

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.Insert(System.Int32,ICSharpCode.NRefactory.Editor.ITextSource)

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.Insert(System.Int32,ICSharpCode.NRefactory.Editor.ITextSource,ICSharpCode.NRefactory.Editor.AnchorMovementType)

Inserts text.

The offset at which the text is inserted. The new text.

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.Insert(System.Int32,System.String,ICSharpCode.NRefactory.Editor.AnchorMovementType)

Gets if an update is running.

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.LastIndexOf(System.Char,System.Int32,System.Int32)

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.LastIndexOf(System.String,System.Int32,System.Int32,System.StringComparison)

Gets the total number of lines in the document. Runtime: O(1).

Is raised when the LineCount property changes.

Gets a read-only list of lines.

Gets the list of s attached to this document. You can add custom line trackers to this list.

Is raised when one of the properties , , , changes.

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.Remove(ICSharpCode.NRefactory.Editor.ISegment)

Removes text.

Starting offset of the text to be removed. Length of the text to be removed.

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.Replace(ICSharpCode.NRefactory.Editor.ISegment,ICSharpCode.NRefactory.Editor.ITextSource)

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.Replace(ICSharpCode.NRefactory.Editor.ISegment,System.String)

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.Replace(System.Int32,System.Int32,ICSharpCode.NRefactory.Editor.ITextSource)

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.Replace(System.Int32,System.Int32,ICSharpCode.NRefactory.Editor.ITextSource,ICSharpCode.AvalonEdit.Document.OffsetChangeMap)

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.Replace(System.Int32,System.Int32,ICSharpCode.NRefactory.Editor.ITextSource,ICSharpCode.AvalonEdit.Document.OffsetChangeMappingType)

Replaces text.

The starting offset of the text to be replaced. The length of the text to be replaced. The new text.

Replaces text.

The starting offset of the text to be replaced. The length of the text to be replaced. The new text. The offsetChangeMap determines how offsets inside the old text are mapped to the new text. This affects how the anchors and segments inside the replaced region behave. If you pass null (the default when using one of the other overloads), the offsets are changed as in OffsetChangeMappingType.Normal mode. If you pass OffsetChangeMap.Empty, then everything will stay in its old place (OffsetChangeMappingType.CharacterReplace mode). The offsetChangeMap must be a valid 'explanation' for the document change. See . Passing an OffsetChangeMap to the Replace method will automatically freeze it to ensure the thread safety of the resulting DocumentChangeEventArgs instance.

Replaces text.

The starting offset of the text to be replaced. The length of the text to be replaced. The new text. The offsetChangeMappingType determines how offsets inside the old text are mapped to the new text. This affects how the anchors and segments inside the replaced region behave.

Immediately calls , and returns an IDisposable that calls .

Gets/Sets the service provider associated with this document. By default, every TextDocument has its own ServiceContainer; and has the document itself registered as and .

Transfers ownership of the document to another thread. This method can be used to load a file into a TextDocument on a background thread and then transfer ownership to the UI thread for displaying the document.

Gets/Sets the text of the whole document.

This event is called after a group of changes is completed.

summary P:ICSharpCode.AvalonEdit.Document.TextDocument.TextLength

Is raised when the TextLength property changes.

Gets the of the document.

Occurs when a document change is finished.

Occurs when a document change starts.

Verifies that the current thread is the documents owner thread. Throws an if the wrong thread accesses the TextDocument.

summary P:ICSharpCode.AvalonEdit.Document.TextDocument.Version

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.WriteTextTo(System.IO.TextWriter)

summary M:ICSharpCode.AvalonEdit.Document.TextDocument.WriteTextTo(System.IO.TextWriter,System.Int32,System.Int32)

Contains weak event managers for the TextDocument events.

Weak event manager for the event.

ICSharpCode.AvalonEdit.Document.TextDocumentWeakEventManager.Changed

Weak event manager for the event.

ICSharpCode.AvalonEdit.Document.TextDocumentWeakEventManager.Changing

Weak event manager for the event.

ICSharpCode.AvalonEdit.Document.TextDocumentWeakEventManager.LineCountChanged

Weak event manager for the event.

ICSharpCode.AvalonEdit.Document.TextDocumentWeakEventManager.TextChanged

Weak event manager for the event.

ICSharpCode.AvalonEdit.Document.TextDocumentWeakEventManager.TextLengthChanged

Weak event manager for the event.

ICSharpCode.AvalonEdit.Document.TextDocumentWeakEventManager.UpdateFinished

Weak event manager for the event.

ICSharpCode.AvalonEdit.Document.TextDocumentWeakEventManager.UpdateStarted

A segment that can be put into a .

ICSharpCode.AvalonEdit.Document.TextSegment

Gets/Sets the end offset of the segment.

Gets whether this segment is connected to a TextSegmentCollection and will automatically update its offsets.

Gets/Sets the length of the segment.

This method gets called when the StartOffset/Length/EndOffset properties are set. It is not called when StartOffset/Length/EndOffset change due to document changes

Gets/Sets the start offset of the segment.

Returns a that represents the current .

A that represents the current .

A collection of text segments that supports efficient lookup of segments intersecting with another segment.

Creates a new TextSegmentCollection that needs manual calls to .

Creates a new TextSegmentCollection that updates the offsets automatically.

The document to which the text segments that will be added to the tree belong. When the document changes, the position of the text segments will be updated accordingly.

Adds the specified segment to the tree. This will cause the segment to update when the document changes.

Removes all segments from the tree.

Gets whether this tree contains the specified item.

Copies all segments in this SegmentTree to the specified array.

Gets the number of segments in the tree.

Gets the first segment with a start offset greater or equal to . Returns null if no such segment is found.

summary M:ICSharpCode.AvalonEdit.Document.TextSegmentCollection`1.FindOverlappingSegments(ICSharpCode.NRefactory.Editor.ISegment)

Finds all segments that overlap with the given segment (including touching segments). Segments are returned in the order given by GetNextSegment/GetPreviousSegment.

Returns a new collection containing the results of the query. This means it is safe to modify the TextSegmentCollection while iterating through the result collection.

Finds all segments that contain the given offset. (StartOffset <= offset <= EndOffset) Segments are returned in the order given by GetNextSegment/GetPreviousSegment.

Returns a new collection containing the results of the query. This means it is safe to modify the TextSegmentCollection while iterating through the result collection.

Returns the first segment in the collection or null, if the collection is empty.

Gets an enumerator to enumerate the segments.

Gets the next segment after the specified segment. Segments are sorted by their start offset. Returns null if segment is the last segment.

Gets the previous segment before the specified segment. Segments are sorted by their start offset. Returns null if segment is the first segment.

Returns the last segment in the collection or null, if the collection is empty.

Removes the specified segment from the tree. This will cause the segment to not update anymore when the document changes.

Updates the start and end offsets of all segments stored in this collection.

DocumentChangeEventArgs instance describing the change to the document.

Updates the start and end offsets of all segments stored in this collection.

OffsetChangeMapEntry instance describing the change to the document.

Static helper methods for working with text.

summary M:ICSharpCode.AvalonEdit.Document.TextUtilities.FindNextNewLine(ICSharpCode.NRefactory.Editor.ITextSource,System.Int32,System.String@)

Gets whether the character is whitespace, part of an identifier, or line terminator.

Gets the name of the control character. For unknown characters, the unicode codepoint is returned as 4-digit hexadecimal value.

Gets the leading whitespace segment on the document line.

summary M:ICSharpCode.AvalonEdit.Document.TextUtilities.GetNewLineFromDocument(ICSharpCode.NRefactory.Editor.IDocument,System.Int32)

summary M:ICSharpCode.AvalonEdit.Document.TextUtilities.GetNextCaretPosition(ICSharpCode.NRefactory.Editor.ITextSource,System.Int32,System.Windows.Documents.LogicalDirection,ICSharpCode.AvalonEdit.Document.CaretPositioningMode)

summary M:ICSharpCode.AvalonEdit.Document.TextUtilities.GetSingleIndentationSegment(ICSharpCode.NRefactory.Editor.ITextSource,System.Int32,System.Int32)

Gets the trailing whitespace segment on the document line.

summary M:ICSharpCode.AvalonEdit.Document.TextUtilities.GetWhitespaceAfter(ICSharpCode.NRefactory.Editor.ITextSource,System.Int32)

summary M:ICSharpCode.AvalonEdit.Document.TextUtilities.GetWhitespaceBefore(ICSharpCode.NRefactory.Editor.ITextSource,System.Int32)

Gets whether the specified string is a newline sequence.

Normalizes all new lines in to be .

Undo stack implementation.

ICSharpCode.AvalonEdit.Document.UndoStack

Gets if the undo stack currently accepts changes. Is false while an undo action is running.

Gets if there are actions on the redo stack. Use the PropertyChanged event to listen to changes of this property.

Gets if there are actions on the undo stack. Use the PropertyChanged event to listen to changes of this property.

Clears both the undo and redo stack.

Call this method, if you want to clear the redo stack

Discards the current "original" marker.

Stops grouping changes.

Gets whether the document is currently in its original state (no modifications).

If an undo group is open, gets the group descriptor of the current top-level undo group. If no undo group is open, gets the group descriptor from the previous undo group.

Marks the current state as original. Discards any previous "original" markers.

Is raised when a property (CanUndo, CanRedo) changed.

Call this method to push an UndoableOperation on the undostack. The redostack will be cleared if you use this method.

Call this method to push an UndoableOperation on the undostack. However, the operation will be only stored if the undo group contains a non-optional operation. Use this method to store the caret position/selection on the undo stack to prevent having only actions that affect only the caret and not the document.

Call this method to redo the last undone operation

Gets/Sets the limit on the number of items on the undo stack.

Starts grouping changes, continuing with the previously closed undo group if possible. Maintains a counter so that nested calls are possible. If the call to StartContinuedUndoGroup is a nested call, it behaves exactly as , only top-level calls can continue existing undo groups.

An object that is stored with the undo group. If this is not a top-level undo group, the parameter is ignored.

Starts grouping changes. Maintains a counter so that nested calls are possible.

An object that is stored with the undo group. If this is not a top-level undo group, the parameter is ignored.

Call this method to undo the last operation on the stack

Allows registering a line tracker on a TextDocument using a weak reference from the document to the line tracker.

Deregisters the weak line tracker.

Registers the as line tracker for the . A weak reference to the target tracker will be used, and the WeakLineTracker will deregister itself when the target tracker is garbage collected.

Base class for margins. Margins don't have to derive from this class, it just helps maintaining a reference to the TextView and the TextDocument. AbstractMargin derives from FrameworkElement, so if you don't want to handle visual children and rendering on your own, choose another base class for your margin!

ICSharpCode.AvalonEdit.Editing.AbstractMargin

Gets the document associated with the margin.

Called when the is changing.

Gets/sets the text view for which line numbers are displayed.

TextView property.

Helper class with caret-related methods.

Scrolls the text view so that the caret is visible.

Returns the caret rectangle. The coordinate system is in device-independent pixels from the top of the document.

Gets/Sets the color of the caret.

Gets/Sets the caret column.

Gets/Sets the desired x-position of the caret, in device-independent pixels. This property is NaN if the caret has no desired position.

Makes the caret invisible.

Gets whether the caret is in virtual space.

Gets/Sets the caret line.

Gets/Sets the location of the caret. The getter of this property is faster than because it doesn't have to validate the visual column.

Gets/Sets the caret offset. Setting the caret offset has the side effect of setting the to NaN.

Gets/Sets the position of the caret. Retrieving this property will validate the visual column (which can be expensive). Use the property instead if you don't need the visual column.

Event raised when the caret position has changed. If the caret position is changed inside a document update (between BeginUpdate/EndUpdate calls), the PositionChanged event is raised only once at the end of the document update.

Makes the caret visible and updates its on-screen position.

Gets/Sets the caret visual column.

Contains classes for handling weak events on the Caret class.

Handles the Caret.PositionChanged event.

ICSharpCode.AvalonEdit.Editing.CaretWeakEventManager.PositionChanged

Margin for use with the text area. A vertical dotted line to separate the line numbers from the text view.

Creates a vertical dotted line to separate the line numbers from the text view.

Gets whether the specified UIElement is the result of a DottedLineMargin.Create call.

Wraps exceptions that occur during drag'n'drop. Exceptions during drag'n'drop might get swallowed by WPF/COM, so AvalonEdit catches them and re-throws them later wrapped in a DragDropException.

Creates a new DragDropException.

Deserializes a DragDropException.

Creates a new DragDropException.

Determines whether the document can be modified.

Gets whether insertion is possible at the specified offset.

summary M:ICSharpCode.AvalonEdit.Editing.IReadOnlySectionProvider.GetDeletableSegments(ICSharpCode.NRefactory.Editor.ISegment)

A set of input bindings and event handlers for the text area.

Attaches an input handler to the text area.

Detaches the input handler from the text area.

Gets the text area that the input handler belongs to.

Margin showing line numbers.

ICSharpCode.AvalonEdit.Editing.LineNumberMargin

The font size used for rendering the line number margin. This field is calculated in MeasureOverride() based on the FontFamily etc. properties.

Implements to supply base element hit testing behavior (returning ).

Describes the hit test to perform, including the initial hit point. Results of the test, including the evaluated point.

Maximum length of a line number, in characters

When overridden in a derived class, measures the size in layout required for child elements and determines a size for the -derived class.

The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available. The size that this element determines it needs during layout, based on its calculations of child element sizes.

Called when the is changing.

Invoked when an unhandled routed event is raised on this element. Implement this method to add class handling for this event.

The that contains the event data. The event data reports that the left mouse button was pressed.

Invoked when an unhandled routed event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

The that contains the event data. The event data reports that the left mouse button was released.

Invoked when an unhandled attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

The that contains the event data.

When overridden in a derived class, participates in rendering operations that are directed by the layout system. The rendering instructions for this element are not used directly when this method is invoked, and are instead preserved for later asynchronous use by layout and drawing.

The drawing instructions for a specific element. This context is provided to the layout system.

Called when the is changing.

Receives events from the centralized event manager.

The typeface used for rendering the line number margin. This field is calculated in MeasureOverride() based on the FontFamily etc. properties.

Rectangular selection ("box selection").

Creates a new rectangular selection.

Expands the selection up by one line, creating a rectangular selection. Key gesture: Alt+Shift+Down

Expands the selection left by one character, creating a rectangular selection. Key gesture: Alt+Shift+Left

Expands the selection left by one word, creating a rectangular selection. Key gesture: Ctrl+Alt+Shift+Left

Expands the selection right by one character, creating a rectangular selection. Key gesture: Alt+Shift+Right

Expands the selection left by one word, creating a rectangular selection. Key gesture: Ctrl+Alt+Shift+Right

Expands the selection to the end of the line, creating a rectangular selection. Key gesture: Alt+Shift+End

Expands the selection to the start of the line, creating a rectangular selection. Key gesture: Alt+Shift+Home

Expands the selection up by one line, creating a rectangular selection. Key gesture: Alt+Shift+Up

Creates a data object containing the selection's text.

Gets whether virtual space is enabled for this selection.

Gets the end position of the selection.

Determines whether the specified is equal to the current .

The to compare with the current . true if the specified is equal to the current ; otherwise, false.

Serves as a hash function for a particular type.

A hash code for the current .

Gets the selected text.

Gets the selection length.

Performs a rectangular paste operation.

Gets the name of the entry in the DataObject that signals rectangle selections.

Replaces the selection with the specified text.

Gets the selected text segments.

Returns a new selection with the changed end point.

Cannot set endpoint for empty selection

Gets the start position of the selection.

If this selection is empty, starts a new selection from to , otherwise, changes the endpoint of this selection.

Gets the smallest segment that contains all segments in this selection. May return null if the selection is empty.

Returns a that represents the current .

A that represents the current .

Updates the selection when the document changes.

Base class for selections.

Constructor for Selection.

Gets whether the specified offset is included in the selection.

True, if the selection contains the offset (selection borders inclusive); otherwise, false.

summary M:ICSharpCode.AvalonEdit.Editing.Selection.Create(ICSharpCode.AvalonEdit.Editing.TextArea,ICSharpCode.NRefactory.Editor.ISegment)

Creates a new simple selection that selects the text from startOffset to endOffset.

Creates a data object containing the selection's text.

Creates a HTML fragment for the selected text.

Gets whether virtual space is enabled for this selection.

Gets the end position of the selection.

Determines whether the specified is equal to the current .

The to compare with the current . true if the specified is equal to the current ; otherwise, false.

Serves as a hash function for a particular type.

A hash code for the current .

Gets the selected text.

Gets whether the selection is empty.

Gets whether the selection is multi-line.

Gets the selection length.

Replaces the selection with the specified text.

Gets the selected text segments.

Returns a new selection with the changed end point.

Cannot set endpoint for empty selection

Gets the start position of the selection.

If this selection is empty, starts a new selection from to , otherwise, changes the endpoint of this selection.

Gets the smallest segment that contains all segments in this selection. May return null if the selection is empty.

Updates the selection when the document changes.

Represents a selected segment.

Creates a SelectionSegment from two offsets.

Creates a SelectionSegment from two offsets and visual columns.

Gets the end offset.

Gets the end visual column.

summary P:ICSharpCode.AvalonEdit.Editing.SelectionSegment.Length

Gets the start offset.

Gets the start visual column.

Returns a that represents the current .

A that represents the current .

Control that wraps a TextView and adds support for user input and the caret.

Creates a new TextArea instance.

Gets/Sets the active input handler. This property does not return currently active stacked input handlers. Setting this property detached all stacked input handlers.

Occurs when the ActiveInputHandler property changes.

Temporarily allows positioning the caret outside the selection. Dispose the returned IDisposable to revert the allowance.

Gets the Caret used for this text area.

Clears the current selection.

Gets the default input handler.

Gets/Sets the document displayed by the text editor.

Occurs when the Document property changes (when the text editor is connected to another document - not when the document content changes).

Document property.

Gets the requested service.

Returns the requested service instance, or null if the service cannot be found.

Implements to supply base element hit testing behavior (returning ).

Describes the hit test to perform, including the initial hit point. Results of the test, including the evaluated point.

Gets/Sets the indentation strategy used when inserting new lines.

IndentationStrategy property.

Gets the collection of margins displayed to the left of the text view.

When overridden in a derived class, is invoked whenever application code or internal processes call .

Invoked when an unhandled attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

The that contains the event data.

Invoked when an unhandled attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

The that contains the event data.

Invoked when an unhandled attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

The that contains the event data.

Invoked when an unhandled attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

The that contains event data.

Invoked when an unhandled attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

The that contains the event data. This event data reports details about the mouse button that was pressed and the handled state.

Raises the event.

Invoked when an unhandled attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

The that contains the event data.

Invoked when an unhandled attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

The that contains the event data.

Invoked whenever the effective value of any dependency property on this has been updated. The specific dependency property that changed is reported in the arguments parameter. Overrides .

The event data that describes the property that changed, as well as old and new values.

Raises the TextEntered event.

Raises the TextEntering event.

Invoked when an unhandled attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

The that contains the event data.

Occurs when a text editor option has changed.

Gets/Sets the document displayed by the text editor.

Options property.

Gets/Sets whether overstrike mode is active.

The dependency property.

Performs text input. This raises the event, replaces the selection with the text, and then raises the event.

Pops the stacked input handler (and all input handlers above it). If is not found in the currently stacked input handlers, or is null, this method does nothing.

Pushes an input handler onto the list of stacked input handlers.

Gets/Sets an object that provides read-only sections for the text area.

Receives events from the centralized event manager.

Gets/Sets the selection in this text area.

Gets/Sets the background brush used for the selection.

The property.

Gets/Sets the background brush used for the selection.

The property.

Occurs when the selection has changed.

Gets/Sets the corner radius of the selection.

The property.

Gets/Sets the foreground brush used selected text.

The property.

Gets the list of currently active stacked input handlers.

Occurs when text inside the TextArea was copied.

Occurs when the TextArea receives text input. This is like the event, but occurs immediately after the TextArea handles the TextInput event.

Occurs when the TextArea receives text input. This is like the event, but occurs immediately before the TextArea handles the TextInput event.

Gets the text view used to display text in this text area.

Contains the predefined input handlers.

Creates a new TextAreaDefaultInputHandler instance.

Gets the caret navigation input handler.

Gets the editing input handler.

Gets the mouse selection input handler.

Default-implementation of .

Creates a new TextAreaInputHandler.

Adds a command and input binding.

The command ID. The modifiers of the keyboard shortcut. The key of the keyboard shortcut. The event handler to run when the command is executed.

Attaches an input handler to the text area.

Gets the command bindings of this input handler.

Detaches the input handler from the text area.

Gets the input bindings of this input handler.

Gets whether the input handler is currently attached to the text area.

Gets the collection of nested input handlers. NestedInputHandlers are activated and deactivated together with this input handler.

Gets the text area that the input handler belongs to.

Stacked input handler. Uses OnEvent-methods instead of registering event handlers to ensure that the events are handled in the correct order.

Creates a new TextAreaInputHandler.

Attaches an input handler to the text area.

Detaches the input handler from the text area.

Called for the PreviewKeyDown event.

Called for the PreviewKeyUp event.

Gets the text area that the input handler belongs to.

EventArgs with text.

Creates a new TextEventArgs instance.

Gets the text.

Implementation for that stores the segments in a .

Creates a new TextSegmentReadOnlySectionProvider instance for the specified document.

Creates a new TextSegmentReadOnlySectionProvider instance using the specified TextSegmentCollection.

Gets whether insertion is possible at the specified offset.

summary M:ICSharpCode.AvalonEdit.Editing.TextSegmentReadOnlySectionProvider`1.GetDeletableSegments(ICSharpCode.NRefactory.Editor.ISegment)

Gets the collection storing the read-only segments.

A that produces line elements for folded s.

ICSharpCode.AvalonEdit.Folding.FoldingElementGenerator

Constructs an element at the specified offset. May return null if no element should be constructed.

Default brush for folding element text. Value: Brushes.Gray

Gets/Sets the folding manager from which the foldings should be shown.

Gets the first offset >= startOffset where the generator wants to construct an element. Return -1 to signal no interest.

Initializes the generator for the

Gets/sets the brush used for folding element text.

Stores a list of foldings for a specific TextView and TextDocument.

Creates a new FoldingManager instance.

Gets all foldings in this manager. The foldings are returned sorted by start offset; for multiple foldings at the same offset the order is undefined.

Removes all folding sections.

Creates a folding for the specified text section.

Gets all foldings that start exactly at .

Gets all foldings that contain .

Gets the first offset greater or equal to where a folded folding starts. Returns -1 if there are no foldings after .

Gets the first folding with a greater or equal to . Returns null if there are no foldings after .

Adds Folding support to the specified text area. Warning: The folding manager is only valid for the text area's current document. The folding manager must be uninstalled before the text area is bound to a different document.

The that manages the list of foldings inside the text area.

Receives events from the centralized event manager.

Removes a folding section from this manager.

Uninstalls the folding manager.

The specified manager was not created using .

Updates the foldings in this using the given new foldings. This method will try to detect which new foldings correspond to which existing foldings; and will keep the state () for existing foldings.

The new set of foldings. These must be sorted by starting offset. The first position of a parse error. Existing foldings starting after this offset will be kept even if they don't appear in . Use -1 for this parameter if there were no parse errors.

A margin that shows markers for foldings and allows to expand/collapse the foldings.

ICSharpCode.AvalonEdit.Folding.FoldingMargin

When overridden in a derived class, positions child elements and determines a size for a derived class.

The final area within the parent that this element should use to arrange itself and its children. The actual size used.

Gets/Sets the folding manager from which the foldings should be shown.

Gets/sets the Brush used for displaying the background of folding markers.

FoldingMarkerBackgroundBrush dependency property.

Gets/sets the Brush used for displaying the lines of folding markers.

FoldingMarkerBrush dependency property.

Overrides , and returns a child at the specified index from a collection of child elements.

The zero-based index of the requested child element in the collection. The requested child element. This should not return null; if the provided index is out of range, an exception is thrown.

When overridden in a derived class, measures the size in layout required for child elements and determines a size for the -derived class.

The drawing instructions for a specific element. This context is provided to the layout system.

Called when the is changing.

Gets/sets the Brush used for displaying the background of selected folding markers.

SelectedFoldingMarkerBackgroundBrush dependency property.

Gets/sets the Brush used for displaying the lines of selected folding markers.

SelectedFoldingMarkerBrush dependency property.

Gets the number of visual child elements within this element.

The number of visual child elements for this element.

A section that can be folded.

Gets/sets if the section is folded.

Gets/Sets an additional object associated with this folding section.

Gets the content of the collapsed lines as text.

Gets/Sets the text used to display the collapsed version of the folding section.

Gets the content of the collapsed lines as tooltip text.

Helper class used for .

Creates a new NewFolding instance.

Gets/Sets whether the folding is closed by default.

Gets/Sets the end offset.

Gets/Sets whether the folding is considered to be a definition. This has an effect on the 'Show Definitions only' command.

Gets/Sets the name displayed for the folding.

Gets/Sets the start offset.

Determines folds for an xml string in the editor.

ICSharpCode.AvalonEdit.Folding.XmlFoldingStrategy

Create s for the specified document.

Flag indicating whether attributes should be displayed on folded elements.

Create s for the specified document and updates the folding manager with them.

This class can syntax-highlight a document. It automatically manages invalidating the highlighting when the document changes.

Creates a new DocumentHighlighter instance.

ICSharpCode.AvalonEdit.Highlighting.DocumentHighlighter

Opens a group of calls. It is not necessary to call this method before calling , however, doing so can make the highlighting much more performant in some cases (e.g. the C# semantic highlighter in SharpDevelop will re-use the resolver within a highlighting group).

Gets the default text color.

Disposes the document highlighter.

Gets the document that this DocumentHighlighter is highlighting.

Closes the currently opened group of calls.

Gets the stack of active colors (the colors associated with the active spans) at the end of the specified line. -> GetColorStack(1) returns the colors at the start of the second line.

Retrieves the HighlightingColor with the specified name. Returns null if no color matching the name is found.

Gets the span stack at the end of the specified line. -> GetSpanStack(1) returns the spans at the start of the second line.

Notification when the highlighter detects that the highlighting state at the beginning of the specified lines has changed. fromLineNumber and toLineNumber are both inclusive; the common case of a single-line change is represented by fromLineNumber == toLineNumber. During highlighting, the highlighting of line X will cause this event to be raised for line X+1 if the highlighting state at the end of line X has changed from its previous state. This event may also be raised outside of the highlighting process to signalize that changes to external data (not the document text; but e.g. semantic information) require a re-highlighting of the specified lines.

Highlights the specified document line.

The line to highlight. A line object that represents the highlighted sections.

Gets/sets the the initial span stack of the document. Default value is .

Invalidates all stored highlighting info. When the document changes, the highlighting is invalidated automatically, this method needs to be called only when there are changes to the highlighting rule set.

Is called when the highlighting state at the end of the specified line has changed.

Enforces a highlighting state update (triggering the HighlightingStateChanged event if necessary) for all lines up to (and inclusive) the specified line number.

Takes a series of highlighting commands and stores them. Later, it can build inline objects (for use with WPF TextBlock) from the commands.

Creates a new HighlightedInlineBuilder instance.

Clones this HighlightedInlineBuilder.

Creates WPF Run instances that can be used for TextBlock.Inlines.

Sets the background brush on the specified text segment.

Sets the font style on the specified text segment.

Sets the font weight on the specified text segment.

Sets the foreground brush on the specified text segment.

Applies the properties from the HighlightingColor to the specified text segment.

Gets the text.

Creates a RichText instance.

Represents a highlighted document line.

ICSharpCode.AvalonEdit.Highlighting.HighlightedLine

Gets the document associated with this HighlightedLine.

Gets the document line associated with this HighlightedLine.

Merges the additional line into this line.

Gets the highlighted sections. The sections are not overlapping, but they may be nested. In that case, outer sections come in the list before inner sections. The sections are sorted by start offset.

Produces HTML code for the line, with tags.

Produces HTML code for a section of the line, with tags.

Creates a that stores the text and highlighting of this line.

Creates a that stores the highlighting of this line.

Returns a that represents the current .

A that represents the current .

Validates that the sections are sorted correctly, and that they are not overlapping.

A text section with syntax highlighting information.

ICSharpCode.AvalonEdit.Highlighting.HighlightedSection

Gets the highlighting color associated with the highlighted section.

Gets/sets the length of the section.

Gets/sets the document offset of the section.

Returns a that represents the current .

A that represents the current .

A brush used for syntax highlighting. Can retrieve a real brush on-demand.

ICSharpCode.AvalonEdit.Highlighting.HighlightingBrush

Gets the real brush.

The construction context. context can be null!

Gets the color of the brush.

The construction context. context can be null!

A highlighting color is a set of font properties and foreground and background color.

Creates a new HighlightingColor instance.

Deserializes a HighlightingColor.

Gets/sets the background color applied by the highlighting.

Clones this highlighting color. If this color is frozen, the clone will be unfrozen.

Indicates whether the current object is equal to another object of the same type.

An object to compare with this object. true if the current object is equal to the parameter; otherwise, false.

Determines whether the specified is equal to the current .

The to compare with the current . true if the specified is equal to the current ; otherwise, false.

Gets/sets the font style. Null if the highlighting color does not change the font style.

Gets/sets the font weight. Null if the highlighting color does not change the font weight.

Gets/sets the foreground color applied by the highlighting.

Prevent further changes to this highlighting color.

Serves as a hash function for a particular type.

A hash code for the current .

Serializes this HighlightingColor instance.

Gets whether this HighlightingColor instance is frozen.

Overwrites the properties in this HighlightingColor with those from the given color; but maintains the current values where the properties of the given color return null.

Gets/Sets the name of the color.

Gets CSS code for the color.

Returns a that represents the current .

A that represents the current .

A colorizes that interprets a highlighting rule set and colors the document accordingly.

Creates a new HighlightingColorizer instance. Derived classes using this constructor must override the method.

Creates a new HighlightingColorizer instance that uses a fixed highlighter instance. The colorizer can only be used with text views that show the document for which the highlighter was created.

The highlighter to be used.

Creates a new HighlightingColorizer instance.

The highlighting definition.

Applies a highlighting color to a visual line element.

Performs the colorization.

Override this method to colorize an individual document line.

Creates the IHighlighter instance for the specified text document.

This method is called when a text view is removed from this HighlightingColorizer, and also when the TextDocument on any associated text view changes.

Called when added to a text view.

Called when removed from a text view.

This method is called when a new text view is added to this HighlightingColorizer, and also when the TextDocument on any associated text view changes.

Indicates that the highlighting definition that was tried to load was invalid.

Creates a new HighlightingDefinitionInvalidException instance.

Converts between strings and by treating the string as the definition name and calling HighlightingManager.Instance.GetDefinition(name).

ICSharpCode.AvalonEdit.Highlighting.HighlightingDefinitionTypeConverter

Returns whether this converter can convert an object of the given type to the type of this converter, using the specified context.

An that provides a format context. A that represents the type you want to convert from. true if this converter can perform the conversion; otherwise, false.

Returns whether this converter can convert the object to the specified type, using the specified context.

An that provides a format context. A that represents the type you want to convert to. true if this converter can perform the conversion; otherwise, false.

Converts the given object to the type of this converter, using the specified context and culture information.

An that provides a format context. The to use as the current culture. The to convert. An that represents the converted value. The conversion cannot be performed.

Converts the given value object to the specified type, using the specified context and culture information.

An that provides a format context. A . If null is passed, the current culture is assumed. The to convert. The to convert the parameter to. An that represents the converted value. The parameter is null. The conversion cannot be performed.

Regex-based highlighting engine.

Creates a new HighlightingEngine instance.

Gets/sets the current span stack.

summary M:ICSharpCode.AvalonEdit.Highlighting.HighlightingEngine.HighlightLine(ICSharpCode.NRefactory.Editor.IDocument,ICSharpCode.NRefactory.Editor.IDocumentLine)

summary M:ICSharpCode.AvalonEdit.Highlighting.HighlightingEngine.ScanLine(ICSharpCode.NRefactory.Editor.IDocument,ICSharpCode.NRefactory.Editor.IDocumentLine)

Manages a list of syntax highlighting definitions.

ICSharpCode.AvalonEdit.Highlighting.HighlightingManager

Gets a highlighting definition by name. Returns null if the definition is not found.

Gets a highlighting definition by extension. Returns null if the definition is not found.

Gets a copy of all highlightings.

Gets the default HighlightingManager instance. The default HighlightingManager comes with built-in highlightings.

Registers a highlighting definition.

The name to register the definition with. The file extensions to register the definition for. The highlighting definition.

Registers a highlighting definition.

The name to register the definition with. The file extensions to register the definition for. A function that loads the highlighting definition.

A highlighting rule.

ICSharpCode.AvalonEdit.Highlighting.HighlightingRule

Gets/Sets the highlighting color.

Gets/Sets the regular expression for the rule.

Returns a that represents the current .

A that represents the current .

A highlighting rule set describes a set of spans that are valid at a given code location.

Creates a new RuleSet instance.

Gets/Sets the name of the rule set.

Gets the list of rules.

Gets the list of spans.

Returns a that represents the current .

A that represents the current .

A highlighting span is a region with start+end expression that has a different RuleSet inside and colors the region.

ICSharpCode.AvalonEdit.Highlighting.HighlightingSpan

Gets the color used for the text matching the end expression.

Gets/Sets the end expression.

Gets/Sets the rule set that applies inside this span.

Gets the color used for the text between start and end.

Gets/Sets whether the span color includes the end. The default is false.

Gets/Sets whether the span color includes the start. The default is false.

Gets the color used for the text matching the start expression.

Gets/Sets the start expression.

Returns a that represents the current .

A that represents the current .

Event handler for

Allows copying HTML text to the clipboard.

summary M:ICSharpCode.AvalonEdit.Highlighting.HtmlClipboard.CreateHtmlFragment(ICSharpCode.NRefactory.Editor.IDocument,ICSharpCode.AvalonEdit.Highlighting.IHighlighter,ICSharpCode.NRefactory.Editor.ISegment,ICSharpCode.AvalonEdit.Highlighting.HtmlOptions)

Sets the TextDataFormat.Html on the data object to the specified html fragment. This helper methods takes care of creating the necessary CF_HTML header.

Holds options for converting text to HTML.

Creates a default HtmlOptions instance.

Creates a new HtmlOptions instance that copies applicable options from the .

Gets whether the color needs to be written out to HTML.

The amount of spaces a tab gets converted to.

Writes the HTML attribute for the style to the text writer.

Represents a highlighted document.

Gets the default text color.

Gets the underlying text document.

Closes the currently opened group of calls.

Gets the stack of active colors (the colors associated with the active spans) at the end of the specified line. -> GetColorStack(1) returns the colors at the start of the second line.

Retrieves the HighlightingColor with the specified name. Returns null if no color matching the name is found.

Highlights the specified document line.

The line to highlight. A line object that represents the highlighted sections.

Enforces a highlighting state update (triggering the HighlightingStateChanged event if necessary) for all lines up to (and inclusive) the specified line number.

A highlighting definition.

Gets a named highlighting color.

The highlighting color, or null if it is not found.

Gets a rule set by name.

The rule set, or null if it is not found.

Gets the main rule set.

Gets the name of the highlighting definition.

Gets the list of named highlighting colors.

Gets the list of properties.

Interface for resolvers that can solve cross-definition references.

Gets the highlighting definition by name, or null if it is not found.

Represents a immutable piece text with highlighting information.

Creates a RichText instance with the given text and RichTextModel.

The text to use in this RichText instance. The model that contains the formatting to use for this RichText instance. model.DocumentLength should correspond to text.Length. This parameter may be null, in which case the RichText instance just holds plain text.

Concatenates the specified rich texts.

Creates WPF Run instances that can be used for TextBlock.Inlines.

The empty string without any formatting information.

Retrieves the highlighted sections in the specified range. The highlighted sections will be sorted by offset, and there will not be any nested or overlapping sections.

Gets the HighlightingColor for the specified offset.

Gets the text length.

Concatenates the specified rich texts.

Implicit conversion from string to RichText.

Creates a substring of this rich text.

Gets the text.

Produces HTML code for the line, with tags.

Produces HTML code for a section of the line, with tags.

Creates a new RichTextModel with the formatting from this RichText.

Gets the text.

A colorizer that applies the highlighting from a to the editor.

Creates a new RichTextColorizer instance.

Override this method to colorize an individual document line.

Stores rich-text formatting.

Creates a new RichTextModel.

Applies the HighlightingColor to the specified range of text. If the color specifies null for some properties, existing highlighting is preserved.

summary M:ICSharpCode.AvalonEdit.Highlighting.RichTextModel.CreateRuns(ICSharpCode.NRefactory.Editor.ITextSource)

Retrieves the highlighted sections in the specified range. The highlighted sections will be sorted by offset, and there will not be any nested or overlapping sections.

Gets a copy of the HighlightingColor for the specified offset.

Sets the background brush on the specified text segment.

Sets the font style on the specified text segment.

Sets the font weight on the specified text segment.

Sets the foreground brush on the specified text segment.

Sets the HighlightingColor for the specified range of text, completely replacing the existing highlighting in that area.

Updates the start and end offsets of all segments stored in this collection.

OffsetChangeMap instance describing the change to the document.

Updates the start and end offsets of all segments stored in this collection.

OffsetChangeMapEntry instance describing the change to the document.

summary M:ICSharpCode.AvalonEdit.Highlighting.RichTextModel.UpdateOffsets(ICSharpCode.NRefactory.Editor.TextChangeEventArgs)

Highlighting brush implementation that takes a frozen brush.

Creates a new HighlightingBrush with the specified color.

Determines whether the specified is equal to the current .

The to compare with the current . true if the specified is equal to the current ; otherwise, false.

Gets the real brush.

The construction context. context can be null!

Serves as a hash function for a particular type.

A hash code for the current .

Returns a that represents the current .

A that represents the current .

Static class with helper methods to load XSHD highlighting files.

Creates a highlighting definition from the XSHD file.

Lodas a syntax definition from the xml reader.

A visitor over the XSHD element tree.

Visit method for XshdColor

Visit method for XshdImport

Visit method for XshdKeywords

Visit method for XshdRule

Visit method for XshdRuleSet

Visit method for XshdSpan

Xshd visitor implementation that saves an .xshd file as XML.

Creates a new SaveXshdVisitor instance.

XML namespace for XSHD.

Writes the specified syntax definition.

A color in an Xshd file.

Creates a new XshdColor instance.

Deserializes an XshdColor.

Applies the visitor to this element.

Gets/sets the background brush.

Gets/Sets the example text that demonstrates where the color is used.

Gets/sets the font style.

Gets/sets the font weight.

Gets/sets the foreground brush.

Serializes this XshdColor instance.

Gets/sets the name.

An element in a XSHD rule set.

ICSharpCode.AvalonEdit.Highlighting.Xshd.XshdElement

Applies the visitor to this element.

Gets the column number in the .xshd file.

Gets the line number in the .xshd file.

<Import> element.

ICSharpCode.AvalonEdit.Highlighting.Xshd.XshdImport

Applies the visitor to this element.

Gets/sets the referenced rule set.

A list of keywords.

ICSharpCode.AvalonEdit.Highlighting.Xshd.XshdKeywords

Applies the visitor to this element.

The color.

Gets the list of key words.

A property in an Xshd file.

Creates a new XshdColor instance.

Applies the visitor to this element.

Gets/sets the name.

Gets/sets the value.

A reference to an xshd color, or an inline xshd color.

Creates a new XshdReference instance.

Applies the visitor to the inline element, if there is any.

Equality operator.

Indicates whether this instance and a specified object are equal.

Another object to compare to. true if and this instance are the same type and represent the same value; otherwise, false.

Returns the hash code for this instance.

A 32-bit signed integer that is the hash code for this instance.

Gets the inline element.

Equality operator.

Inequality operator.

Gets the reference.

Specifies the type of the regex.

Normal regex. Used when the regex was specified as attribute.

Ignore pattern whitespace / allow regex comments. Used when the regex was specified as text element.

<Rule> element.

ICSharpCode.AvalonEdit.Highlighting.Xshd.XshdRule

Applies the visitor to this element.

Gets/sets the color reference.

Gets/sets the rule regex.

Gets/sets the rule regex type.

A rule set in a XSHD file.

ICSharpCode.AvalonEdit.Highlighting.Xshd.XshdRuleSet

Applies the visitor to all elements.

Applies the visitor to this element.

Gets the collection of elements.

Gets/sets whether the case is ignored in expressions inside this rule set.

Gets/Sets the name of the rule set.

element.

ICSharpCode.AvalonEdit.Highlighting.Xshd.XshdSpan

Applies the visitor to this element.

Gets/sets the span begin color.

Gets/sets the begin regex.

Gets/sets the begin regex type.

Gets/sets the span end color.

Gets/sets the end regex.

Gets/sets the end regex type.

Gets/sets whether the span is multiline.

Gets/sets the rule set reference.

Gets/sets the span color.

A <SyntaxDefinition> element.

Creates a new XshdSyntaxDefinition object.

Applies the visitor to all elements.

Gets the collection of elements.

Gets the associated extensions.

Gets/sets the definition name

Handles indentation by copying the indentation from the previous line. Does not support indenting multiple lines.

ICSharpCode.AvalonEdit.Indentation.DefaultIndentationStrategy

Sets the indentation for the specified line. Usually this is constructed from the indentation of the previous line.

Does nothing: indenting multiple lines is useless without a smart indentation strategy.

Strategy how the text editor handles indentation when new lines are inserted.

Sets the indentation for the specified line. Usually this is constructed from the indentation of the previous line.

Reindents a set of lines.

Smart indentation for C#.

Creates a new CSharpIndentationStrategy.

Creates a new CSharpIndentationStrategy and initializes the settings using the text editor options.

Performs indentation using the specified document accessor.

Object used for accessing the document line-by-line Specifies whether empty lines should be kept

Gets/Sets the indentation string.

Sets the indentation for the specified line. Usually this is constructed from the indentation of the previous line.

Reindents a set of lines.

Interface used for the indentation class to access the document.

Gets if the current line is read only (because it is not in the selected text region)

Gets the number of the current line.

Advances to the next line.

Gets/Sets the text of the current line.

Adapter IDocumentAccessor -> TextDocument

Creates a new TextDocumentAccessor.

Creates a new TextDocumentAccessor that indents only a part of the document.

Gets if the current line is read only (because it is not in the selected text region)

Gets the number of the current line.

Advances to the next line.

Gets/Sets the text of the current line.

Helper for creating a PathGeometry.

Creates a new BackgroundGeometryBuilder instance.

Adds a rectangle to the geometry.

summary M:ICSharpCode.AvalonEdit.Rendering.BackgroundGeometryBuilder.AddSegment(ICSharpCode.AvalonEdit.Rendering.TextView,ICSharpCode.NRefactory.Editor.ISegment)

Gets/Sets whether to align the geometry to the middle of pixels.

Gets/Sets whether to align the geometry to whole pixels.

Closes the current figure.

Gets/sets the radius of the rounded corners.

Creates the geometry. Returns null when the geometry is empty!

Gets/Sets whether to extend the rectangles to full width at line end.

summary M:ICSharpCode.AvalonEdit.Rendering.BackgroundGeometryBuilder.GetRectsForSegment(ICSharpCode.AvalonEdit.Rendering.TextView,ICSharpCode.NRefactory.Editor.ISegment,System.Boolean)

Calculates the rectangles for the visual column segment. This returns one rectangle for each line inside the segment.

Represents a collapsed line section. Use the Uncollapse() method to uncollapse the section.

Gets the end line of the section. When the section is uncollapsed or the text containing it is deleted, this property returns null.

Gets if the document line is collapsed. This property initially is true and turns to false when uncollapsing the section.

Gets the start line of the section. When the section is uncollapsed or the text containing it is deleted, this property returns null.

Gets a string representation of the collapsed section.

Uncollapses the section. This causes the Start and End properties to be set to null! Does nothing if the section is already uncollapsed.

Base class for that helps splitting visual elements so that colors (and other text properties) can be easily assigned to individual words/characters.

ICSharpCode.AvalonEdit.Rendering.ColorizingTransformer

Changes visual element properties. This method accesses , so it must be called only during a call. This method splits s as necessary to ensure that the region can be colored by setting the of whole elements, and then calls the on all elements in the region.

Start visual column of the region to change End visual column of the region to change Action that changes an individual .

Performs the colorization.

Gets the list of elements currently being transformed.

Called when added to a text view.

Called when removed from a text view.

implementation. Sets and calls .

Default implementation for TextRunTypographyProperties.

ICSharpCode.AvalonEdit.Rendering.DefaultTextRunTypographyProperties

Gets the index of an alternate annotation form.

The index of the alternate annotation form. The default is 0 (zero).

Gets a value that indicates the capital form of the selected font.

One of the values. The default is .

Gets a value that indicates whether inter-glyph spacing for all-capital text is globally adjusted to improve readability.

true if spacing is adjusted; otherwise, false. The default is false.

Gets a value that indicates whether glyphs adjust their vertical position to better align with uppercase glyphs.

true if the vertical position is adjusted; otherwise, false. The default is false.

Gets a value that indicates whether custom glyph forms can be used based upon the context of the text being rendered.

true if custom glyph forms can be used; otherwise, false. The default is true.

Gets a value that indicates whether contextual ligatures are enabled.

true if contextual ligatures are enabled; otherwise, false. The default is true.

Gets a value that specifies the index of a contextual swashes form.

The index of the standard swashes form. The default is 0 (zero).

Gets a value that indicates whether discretionary ligatures are enabled.

true if discretionary ligatures are enabled; otherwise, false. The default is false.

Gets a value that indicates whether the standard Japanese font forms have been replaced with the corresponding preferred typographic forms.

true if standard Japanese font forms have been replaced with the corresponding preferred typographic forms; otherwise, false. The default is false.

Gets a value that indicates the version of glyphs to be used for a specific writing system or language.

One of the values. The default is .

Gets a value that indicates the proportional width to be used for Latin characters in an East Asian font.

One of the values. The default is .

Gets a value that indicates the fraction style.

One of the values. The default is .

Gets a value that indicates whether historical forms are enabled.

true if historical forms are enabled; otherwise, false. The default is false.

Gets a value that indicates whether historical ligatures are enabled.

true if historical ligatures are enabled; otherwise, false. The default is false.

Gets a value that indicates whether kerning is enabled.

true if kerning is enabled; otherwise, false. The default is true.

Gets a value that indicates whether standard typographic font forms of Greek glyphs have been replaced with corresponding font forms commonly used in mathematical notation.

true if mathematical Greek forms are enabled; otherwise, false. The default is false.

Gets the alignment of widths when using numerals.

One of the values. The default is .

Gets a value that indicates the set of glyphs that are used to render numeric alternate font forms.

One of the values. The default is .

Gets a value that indicates whether a nominal zero font form should be replaced with a slashed zero.

true if slashed zero forms are enabled; otherwise, false. The default is false.

Gets a value that indicates whether standard ligatures are enabled.

true if standard ligatures are enabled; otherwise, false. The default is true.

Gets the index of a standard swashes form.

The index of the standard swashes form. The default is 0 (zero).

Gets the index of a stylistic alternates form.

The index of the stylistic alternates form. The default is 0 (zero).

Gets a value that indicates whether a stylistic set of a font form is enabled.