TextView Class

public abstract class TextView : UIElement, IInputElement, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, ITextView

protected TextView(SyntaxEditor syntaxEditor, ITextSnapshot initialSnapshot)

Parameter	Type	Description
syntaxEditor	SyntaxEditor	The SyntaxEditor that owns the object.
initialSnapshot	ITextSnapshot	The initial ITextSnapshot.

protected virtual bool ArePartiallyVisibleViewLinesAllowed { get; }

Property Value

bool:

true if partially-visible view lines are allowed; otherwise, false.

protected abstract ITagAggregator<IClassificationTag> ClassificationTagAggregator { get; }

Property Value

ITagAggregator<IClassificationTag>:

The IClassificationTag aggregator for the view.

public abstract ICollapsedRegionManager CollapsedRegionManager { get; }

Property Value

ICollapsedRegionManager:

An ICollapsedRegionManager that provides information about collapsed regions in the view.

public ITextSnapshot CurrentSnapshot { get; }

Property Value

ITextSnapshot:

The ITextSnapshot that currently is used to populate the view.

public Color DefaultBackgroundColor { get; }

Property Value

Color:

The default background color.

public int DefaultCharacterWidth { get; }

Property Value

int:

The width of an average default font character in the view.

public string DefaultFontFamilyName { get; }

Property Value

string:

The default font family name.

public float DefaultFontSize { get; }

Property Value

float:

The default font size.

public FontStyles DefaultFontStyle { get; }

Property Value

FontStyles:

The default font style.

public FontWeights DefaultFontWeight { get; }

Property Value

FontWeights:

The default font weight.

public Color DefaultForegroundColor { get; }

Property Value

Color:

The default foreground color.

public int DefaultLineHeight { get; }

Property Value

int:

The default line height.

public int DefaultSpaceWidth { get; }

Property Value

int:

The width of a default font space character in the view.

public virtual IHighlightingStyleRegistry HighlightingStyleRegistry { get; }

Property Value

IHighlightingStyleRegistry:

The IHighlightingStyleRegistry used by this view.

protected abstract ITagAggregator<IIntraLineSpacerTag> IntraLineSpacerTagAggregator { get; }

Property Value

ITagAggregator<IIntraLineSpacerTag>:

The IIntraLineSpacerTag aggregator for the view.

protected abstract ITagAggregator<IIntraTextSpacerTag> IntraTextSpacerTagAggregator { get; }

Property Value

ITagAggregator<IIntraTextSpacerTag>:

The IIntraTextSpacerTag aggregator for the view.

public bool IsDefaultBackgroundColorLight { get; }

Property Value

bool:

true if the background color of the editor is light; otherwise, false.

public abstract bool IsWhitespaceVisible { get; }

Property Value

bool:

true if whitespace (spaces and tabs) is visible; otherwise, false.

public PropertyDictionary Properties { get; }

Property Value

PropertyDictionary:

The dictionary containing custom properties for this object.

protected virtual TextRange RenderableTextRange { get; }

Property Value

TextRange:

The text range that can be rendered.

Remarks

A value of TextRange.Deleted means no text range limitation.

public TextViewScrollState ScrollState { get; }

Property Value

TextViewScrollState:

The view's current scroll state.

protected abstract Rectangle ScrollableContentHostBounds { get; }

Property Value

Rectangle:

A Rectangle indicating the bounds of scrollable content host, relative to view coordinates.

protected virtual ITagAggregator<ISquiggleTag> SquiggleTagAggregator { get; }

Property Value

ITagAggregator<ISquiggleTag>:

The ISquiggleTag aggregator for the view.

public SyntaxEditor SyntaxEditor { get; }

Property Value

SyntaxEditor:

The SyntaxEditor that contains the view.

public virtual Padding TextAreaPadding { get; }

Property Value

Padding:

The padding thickness around the text area content.

public abstract Size TextAreaSize { get; }

Property Value

Size:

The size of the text area in text area coordinates.

public abstract Rectangle TextAreaViewportBounds { get; }

Property Value

Rectangle:

A Rectangle indicating the bounds of the visible portion of the text area, relative to view coordinates.

public Guid UniqueId { get; }

Property Value

Guid:

The Guid that uniquely identifies the view.

protected abstract ITagAggregator<IUnusedRegionTag> UnusedRegionTagAggregator { get; }

Property Value

ITagAggregator<IUnusedRegionTag>:

The IUnusedRegionTag aggregator for the view.

protected abstract bool UseSyntaxEditorDisplayItemProperties { get; }

Property Value

bool:

true if SyntaxEditor display item properties should be used; otherwise, false.

public ITextViewLineCollection VisibleViewLines { get; }

Property Value

ITextViewLineCollection:

The collection of ITextViewLine objects that are currently visible within the view.

Remarks

The ITextViewLine items in this collection are sorted in their display order, top to bottom.

public IUIElement VisualElement { get; }

Property Value

IUIElement:

The IUIElement that represents the view.

protected abstract WordWrapMode WordWrapMode { get; }

Property Value

WordWrapMode:

A WordWrapMode value indicating the type of word wrapping that is performed.

protected virtual int WrappedLineIndentAmount { get; }

Property Value

int:

The number of characters to indent any wrapped lines beyond the original indent level of the primary line. The default value is 2.

Remarks

A value of 2 will indent wrapped lines to the original indent level of the primary line, plus 2 additional character widths. A value of 0 will indent wrapped lines to the original indent level of the primary line. A value of -1 will not indent wrapped lines at all, and will simply align them to the left edge of the view. The indent amount may be limited or altogether disabled if there is not enough available width in the view to support proper indentation.

public int ZoomLevel { get; }

Property Value

int:

A percentage value indicating the zoom level. The default value is 1.0, meaning 100%.

protected abstract void Close()

public abstract ITagAggregator<T> CreateTagAggregator<T>() where T : ITag

Type Parameters:

T -

The type of ITag associated with this aggregator.

Returns

ITagAggregator<T>:

The ITagAggregator<T> that was created.

public abstract IAdornmentLayer GetAdornmentLayer(AdornmentLayerDefinition layerDefinition)

Parameter	Type	Description
layerDefinition	AdornmentLayerDefinition	The layer definition.

Returns

IAdornmentLayer:

An IAdornmentLayer for the view with the specified string-based key.

Remarks

If no IAdornmentLayer already exists with the specified name, one is created.

public ITextViewLine GetViewLine(TextPosition position)

Parameter	Type	Description
position	TextPosition	The TextPosition for which to retrieve an ITextViewLine.

Returns

ITextViewLine:

An ITextViewLine that contains the specified TextPosition.

public ITextViewLine GetViewLine(ITextViewLine viewLine, int lineDelta)

Parameter	Type	Description
viewLine	ITextViewLine	The source ITextViewLine.
lineDelta	int	The number of lines to traverse (can be negative).

Returns

ITextViewLine:

The ITextViewLine that is relative to the specified ITextViewLine.

public ITextViewLine GetViewLine(ITextViewLine viewLine, int lineDelta, bool forceVirtualSpace)

Parameter	Type	Description
viewLine	ITextViewLine	The source ITextViewLine.
lineDelta	int	The number of lines to traverse (can be negative).
forceVirtualSpace	bool	Whether to force virtual line space to be used as needed (for block selections).

Returns

ITextViewLine:

The ITextViewLine that is relative to the specified ITextViewLine.

public ITextViewLine GetViewLine(int offset)

Parameter	Type	Description
offset	int	The offset for which to retrieve an ITextViewLine.

Returns

ITextViewLine:

An ITextViewLine that contains the specified offset.

public ITextViewLine GetViewLine(int offset, bool hasFarAffinity)

Parameter	Type	Description
offset	int	The offset for which to retrieve an ITextViewLine.
hasFarAffinity	bool	Whether the offset has affinity for the far side, which is used when the offset is where a view line is wrapped to a second view line.

Returns

ITextViewLine:

An ITextViewLine that contains the specified offset.

public void InvalidateRender()

protected void NotifyPropertyChanged(string propertyName)

Parameter	Type	Description
propertyName	string	The name of the property that was changed.

public TextPosition OffsetToPosition(int offset)

Parameter	Type	Description
offset	int	The offset of a character within the document.

Returns

TextPosition:

The TextPosition that represents the specified offset within the view lines.

protected virtual void OnClosed(EventArgs e)

Parameter	Type	Description
e	EventArgs	The EventArgs that contains the event data.

protected virtual void OnMarginsDestroyed(EventArgs e)

Parameter	Type	Description
e	EventArgs	The EventArgs that contains the event data.

protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)

Parameter	Type	Description
e	PropertyChangedEventArgs	The PropertyChangedEventArgs that contains the event data.

protected virtual void OnRendered()

protected virtual void OnScrollBarUpdateRequested(EventArgs e)

Parameter	Type	Description
e	EventArgs	The EventArgs that contains the event data.

protected virtual void OnScrollStatePropertyChanged(TextViewScrollState oldValue, TextViewScrollState newValue)

Parameter	Type	Description
oldValue	TextViewScrollState	The old value.
newValue	TextViewScrollState	The new value.

protected virtual void OnTextAreaLayout(TextViewTextAreaLayoutEventArgs e)

Parameter	Type	Description
e	TextViewTextAreaLayoutEventArgs	The TextViewTextAreaLayoutEventArgs that contains the event data.

public void PerformLayout()

public int PositionToOffset(TextPosition position)

Parameter	Type	Description
position	TextPosition	The TextPosition of a character within the view lines.

Returns

int:

The offset for the specified TextPosition within the view lines.

public abstract Point TransformFromTextArea(Point location)

Parameter	Type	Description
location	Point	The Point to transform.

Returns

Point:

The transformed Point.

public abstract Rectangle TransformFromTextArea(Rectangle bounds)

Parameter	Type	Description
bounds	Rectangle	The Rectangle to transform.

Returns

Rectangle:

The transformed Rectangle.

public abstract Point TransformToTextArea(Point location)

Parameter	Type	Description
location	Point	The Point to transform.

Returns

Point:

The transformed Point.

public abstract Rectangle TransformToTextArea(Rectangle bounds)

Parameter	Type	Description
bounds	Rectangle	The Rectangle to transform.

Returns

Rectangle:

The transformed Rectangle.

public event EventHandler Closed

Event Type

EventHandler

public event EventHandler MarginsDestroyed

Event Type

EventHandler

public event PropertyChangedEventHandler PropertyChanged

Event Type

PropertyChangedEventHandler

public event EventHandler ScrollBarUpdateRequested

Event Type

EventHandler

public event EventHandler<TextViewTextAreaLayoutEventArgs> TextAreaLayout

Event Type

EventHandler<TextViewTextAreaLayoutEventArgs>