TextView Class

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 double DefaultCharacterWidth { get; }

Property Value

double:

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 FontStyle DefaultFontStyle { get; }

Property Value

FontStyle:

The default font style.

public FontWeight DefaultFontWeight { get; }

Property Value

FontWeight:

The default font weight.

public Color DefaultForegroundColor { get; }

Property Value

Color:

The default foreground color.

public double DefaultLineHeight { get; }

Property Value

double:

The default line height.

public double DefaultSpaceWidth { get; }

Property Value

double:

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 Rect ScrollableContentHostBounds { get; }

Property Value

Rect:

A System.Windows.Rect 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 Thickness TextAreaPadding { get; }

Property Value

Thickness:

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 Rect TextAreaViewportBounds { get; }

Property Value

Rect:

A System.Windows.Rect 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 FrameworkElement VisualElement { get; }

Property Value

FrameworkElement:

The FrameworkElement 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 double ZoomLevel { get; }

Property Value

double:

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

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)

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)

Returns

ITextViewLine:

An ITextViewLine that contains the specified TextPosition.

public ITextViewLine GetViewLine(ITextViewLine viewLine, int lineDelta)

Returns

ITextViewLine:

The ITextViewLine that is relative to the specified ITextViewLine.

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

Returns

ITextViewLine:

The ITextViewLine that is relative to the specified ITextViewLine.

public ITextViewLine GetViewLine(int offset)

Returns

ITextViewLine:

An ITextViewLine that contains the specified offset.

public ITextViewLine GetViewLine(int offset, bool hasFarAffinity)

Returns

ITextViewLine:

An ITextViewLine that contains the specified offset.

public TextPosition OffsetToPosition(int offset)

Returns

TextPosition:

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

public int PositionToOffset(TextPosition position)

Returns

int:

The offset for the specified TextPosition within the view lines.

public abstract Point TransformFromTextArea(Point location)

Returns

Point:

The transformed System.Windows.Point.

public abstract Rect TransformFromTextArea(Rect bounds)

Returns

Rect:

The transformed System.Windows.Rect.

public abstract Point TransformToTextArea(Point location)

Returns

Point:

The transformed System.Windows.Point.

public abstract Rect TransformToTextArea(Rect bounds)

Returns

Rect:

The transformed System.Windows.Rect.

public event RoutedEventHandler Closed

Event Type

RoutedEventHandler

public event RoutedEventHandler MarginsDestroyed

Event Type

RoutedEventHandler

public event RoutedEventHandler ScrollBarUpdateRequested

Event Type

RoutedEventHandler

public event EventHandler<TextViewTextAreaLayoutEventArgs> TextAreaLayout

Event Type

EventHandler<TextViewTextAreaLayoutEventArgs>