ITextView Interface

public interface ITextView

ICollapsedRegionManager CollapsedRegionManager { get; }

Property Value

ICollapsedRegionManager:

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

ITextSnapshot CurrentSnapshot { get; }

Property Value

ITextSnapshot:

The ITextSnapshot that currently is used to populate the view.

Color DefaultBackgroundColor { get; }

Property Value

Color:

The default background color.

int DefaultCharacterWidth { get; }

Property Value

int:

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

string DefaultFontFamilyName { get; }

Property Value

string:

The default font family name.

float DefaultFontSize { get; }

Property Value

float:

The default font size.

Color DefaultForegroundColor { get; }

Property Value

Color:

The default foreground color.

int DefaultLineHeight { get; }

Property Value

int:

The default line height.

int DefaultSpaceWidth { get; }

Property Value

int:

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

IHighlightingStyleRegistry HighlightingStyleRegistry { get; }

Property Value

IHighlightingStyleRegistry:

The IHighlightingStyleRegistry used by this view.

bool IsDefaultBackgroundColorLight { get; }

Property Value

bool:

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

bool IsWhitespaceVisible { get; }

Property Value

bool:

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

PropertyDictionary Properties { get; }

Property Value

PropertyDictionary:

The dictionary containing custom properties for this object.

TextViewScrollState ScrollState { get; }

Property Value

TextViewScrollState:

The view's current scroll state.

SyntaxEditor SyntaxEditor { get; }

Property Value

SyntaxEditor:

The SyntaxEditor that contains the view.

Padding TextAreaPadding { get; }

Property Value

Padding:

The padding thickness around the text area content.

Size TextAreaSize { get; }

Property Value

Size:

The size of the text area in text area coordinates.

Rectangle TextAreaViewportBounds { get; }

Property Value

Rectangle:

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

Guid UniqueId { get; }

Property Value

Guid:

The Guid that uniquely identifies the view.

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.

IUIElement VisualElement { get; }

Property Value

IUIElement:

The IUIElement that represents the view.

int ZoomLevel { get; }

Property Value

int:

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

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.

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.

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.

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.

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). The default value is false.

Returns

ITextViewLine:

The ITextViewLine that is relative to the specified ITextViewLine.

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.

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.

void InvalidateRender()

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.

void PerformLayout()

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.

Point TransformFromTextArea(Point location)

Parameter	Type	Description
location	Point	The Point to transform.

Returns

Point:

The transformed Point.

Rectangle TransformFromTextArea(Rectangle bounds)

Parameter	Type	Description
bounds	Rectangle	The Rectangle to transform.

Returns

Rectangle:

The transformed Rectangle.

Point TransformToTextArea(Point location)

Parameter	Type	Description
location	Point	The Point to transform.

Returns

Point:

The transformed Point.

Rectangle TransformToTextArea(Rectangle bounds)

Parameter	Type	Description
bounds	Rectangle	The Rectangle to transform.

Returns

Rectangle:

The transformed Rectangle.

event EventHandler Closed

Event Type

EventHandler

event EventHandler MarginsDestroyed

Event Type

EventHandler

event EventHandler<TextViewTextAreaLayoutEventArgs> TextAreaLayout

Event Type

EventHandler<TextViewTextAreaLayoutEventArgs>