Formatted text (not normal document text).
This is used as base class for various VisualLineElements that are displayed using a
FormattedText, for example newline markers or collapsed folding sections.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class FormattedTextElement : VisualLineElement
Public Class FormattedTextElement _ Inherits VisualLineElement
public ref class FormattedTextElement : public VisualLineElement
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | FormattedTextElement(String, Int32) |
Creates a new FormattedTextElement that displays the specified text
and occupies the specified length in the document.
|
| FormattedTextElement(TextLine, Int32) |
Creates a new FormattedTextElement that displays the specified text
and occupies the specified length in the document.
|
| FormattedTextElement(FormattedText, Int32) |
Creates a new FormattedTextElement that displays the specified text
and occupies the specified length in the document.
|
 | BackgroundBrush |
Gets/sets the brush used for the background of this VisualLineElement.
(Inherited from VisualLineElement.) |
| BreakAfter |
Gets/sets the line break condition after the element.
The default is 'BreakPossible'.
|
| BreakBefore |
Gets/sets the line break condition before the element.
The default is 'BreakPossible'.
|
| CanSplit |
Gets if this VisualLineElement can be split.
(Inherited from VisualLineElement.) |
| CreateTextRun(Int32, ITextRunConstructionContext) |
Creates the TextRun for this line element.
(Overrides VisualLineElement.CreateTextRun(Int32, ITextRunConstructionContext).) |
| DocumentLength |
Gets the length of this element in the text document.
(Inherited from VisualLineElement.) |
| Equals(Object) | (Inherited from Object.) |
 | Finalize()()()() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetNextCaretPosition(Int32, LogicalDirection, CaretPositioningMode) |
Gets the next caret position inside this element.
(Inherited from VisualLineElement.) |
| GetPrecedingText(Int32, ITextRunConstructionContext) |
Retrieves the text span immediately before the visual column.
(Inherited from VisualLineElement.) |
| GetRelativeOffset(Int32) |
Gets the text offset of a visual column inside this element.
(Inherited from VisualLineElement.) |
| GetType()()()() | Gets the Type of the current instance. (Inherited from Object.) |
| GetVisualColumn(Int32) |
Gets the visual column of a text location inside this element.
The text offset is given relative to the visual line start.
(Inherited from VisualLineElement.) |
| HandlesLineBorders |
Gets whether the GetNextCaretPosition(Int32, LogicalDirection, CaretPositioningMode) implementation handles line borders.
If this property returns false, the caller of GetNextCaretPosition should handle the line
borders (i.e. place caret stops at the start and end of the line).
This property has an effect only for VisualLineElements that are at the start or end of a
VisualLine.
(Inherited from VisualLineElement.) |
| IsWhitespace(Int32) |
Gets whether the specified offset in this element is considered whitespace.
(Inherited from VisualLineElement.) |
| MemberwiseClone()()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnMouseDown(MouseButtonEventArgs) |
Allows the visual line element to handle a mouse event.
(Inherited from VisualLineElement.) |
| OnMouseUp(MouseButtonEventArgs) |
Allows the visual line element to handle a mouse event.
(Inherited from VisualLineElement.) |
| OnQueryCursor(QueryCursorEventArgs) |
Queries the cursor over the visual line element.
(Inherited from VisualLineElement.) |
 | PrepareText(TextFormatter, String, TextRunProperties) |
Constructs a TextLine from a simple text.
|
| RelativeTextOffset |
Gets the text offset where this element starts, relative to the start text offset of the visual line.
(Inherited from VisualLineElement.) |
| Split(Int32, IList<(Of <<'(VisualLineElement>)>>), Int32) |
Splits the element.
(Inherited from VisualLineElement.) |
| SplitHelper(VisualLineElement, VisualLineElement, Int32, Int32) |
Helper method for splitting this line element into two, correctly updating the
VisualLength, DocumentLength, VisualColumn
and RelativeTextOffset properties.
(Inherited from VisualLineElement.) |
| TextRunProperties |
Gets the text run properties.
A unique VisualLineElementTextRunProperties instance is used for each
VisualLineElement; colorizing code may assume that modifying the
VisualLineElementTextRunProperties will affect only this
VisualLineElement.
(Inherited from VisualLineElement.) |
| ToString()()()() | (Inherited from Object.) |
| VisualColumn |
Gets the visual column where this element starts.
(Inherited from VisualLineElement.) |
| VisualLength |
Gets the length of this element in visual columns.
(Inherited from VisualLineElement.) |
Inheritance Hierarchy| Object | ||
 | VisualLineElement | |
| FormattedTextElement | |
Assembly: ICSharpCode.AvalonEdit (Module: ICSharpCode.AvalonEdit.dll) Version: 5.0.0.4238