Represents a highlighted document.
Declaration Syntax
C# | Visual Basic | Visual C++ |
public interface IHighlighter : IDisposable
Public Interface IHighlighter _ Inherits IDisposable
public interface class IHighlighter : IDisposable
Members
All Members | Methods | Properties | Events | ||
Icon | Member | Description |
---|---|---|
BeginHighlighting()()()() |
Opens a group of HighlightLine(Int32) calls.
It is not necessary to call this method before calling HighlightLine(Int32),
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).
| |
DefaultTextColor |
Gets the default text color.
| |
Dispose()()()() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) | |
Document |
Gets the underlying text document.
| |
EndHighlighting()()()() |
Closes the currently opened group of HighlightLine(Int32) calls.
| |
GetColorStack(Int32) |
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.
| |
GetNamedColor(String) |
Retrieves the HighlightingColor with the specified name. Returns null if no color matching the name is found.
| |
HighlightingStateChanged |
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.
| |
HighlightLine(Int32) |
Highlights the specified document line.
| |
UpdateHighlightingState(Int32) |
Enforces a highlighting state update (triggering the HighlightingStateChanged event if necessary)
for all lines up to (and inclusive) the specified line number.
|
Remarks
This interface is used by the HighlightingColorizer to register the highlighter as a TextView service.
Assembly: ICSharpCode.AvalonEdit (Module: ICSharpCode.AvalonEdit.dll) Version: 5.0.0.4238