ITextViewLine Interface

public interface ITextViewLine : ITextRangeProvider

double Baseline { get; }

Property Value

double:

The distance from the top of the line to the baseline of the text.

double BottomMargin { get; }

Property Value

double:

The margin length below the line's text bounds.

Rect Bounds { get; }

Property Value

Rect:

The bounds of the line within the view, including any margin space.

TextViewLineChange Change { get; }

Property Value

TextViewLineChange:

A TextViewLineChange that indicates the change made to the text represented by the line on the last layout pass.

int CharacterCount { get; }

Property Value

int:

The number of characters that are displayed on the line, excluding any collapsed text ranges.

int EndOffset { get; }

Property Value

int:

The offset at which the line ends, excluding any line terminator.

int EndOffsetIncludingLineTerminator { get; }

Property Value

int:

The offset at which the line ends, including the line terminator if there is a hard line break on the line.

TextPosition EndPosition { get; }

Property Value

TextPosition:

The TextPosition at which the line ends, excluding any line terminator.

TextPosition EndPositionIncludingLineTerminator { get; }

Property Value

TextPosition:

The TextPosition at which the line ends, including the line terminator if there is a hard line break on the line.

int FirstNonWhitespaceCharacterIndex { get; }

Property Value

int:

The index of the first non-whitespace character in the line.

int FirstNonWhitespaceOffset { get; }

Property Value

int:

The offset of the first non-whitespace character in the line.

bool HasHardLineBreak { get; }

Property Value

bool:

true if the the line has a hard line break; otherwise, false.

Remarks

This property will return false when there is a word-wrapped line following the line.

int IndentAmount { get; }

Property Value

int:

The number of columns that the first non-whitespace character is indented on the line.

bool IsFirstLine { get; }

Property Value

bool:

true if the line contains the first offset of the document; otherwise, false.

bool IsLastLine { get; }

Property Value

bool:

true if the line contains the last offset of the document; otherwise, false.

bool IsPureWhitespace { get; }

Property Value

bool:

true if the line consists purely of whitespace characters; otherwise, false.

bool IsVirtualLine { get; }

Property Value

bool:

true if the line is a virtual line, past the end of the document; otherwise, false.

bool IsWrapped { get; }

Property Value

bool:

true if the line is wrapped from the previous line; otherwise, false .

TextPosition MaxPosition { get; }

Property Value

TextPosition:

The maximum TextPosition that can be displayed on the line.

ITextViewLine NextLine { get; }

Property Value

ITextViewLine:

The ITextViewLine that is after this line.

TextPositionRange PositionRange { get; }

Property Value

TextPositionRange:

The TextPositionRange that contains the line.

ITextViewLine PreviousLine { get; }

Property Value

ITextViewLine:

The ITextViewLine that is before this line.

SavePointChangeType SavePointChangeType { get; }

Property Value

SavePointChangeType:

A SavePointChangeType that indicates the type of change that has been made on the line relative to the save point.

Size Size { get; }

Property Value

Size:

The Size of the line, including any margin space.

TextSnapshotRange SnapshotRange { get; }

Property Value

TextSnapshotRange:

The TextSnapshotRange that indicates the snapshot range of the line.

TextSnapshotRange SnapshotRangeIncludingLineTerminator { get; }

Property Value

TextSnapshotRange:

The TextSnapshotRange that indicates the snapshot range of the line, including the line terminator if there is a hard line break on the line.

int StartOffset { get; }

Property Value

int:

The offset at which the line starts.

TextPosition StartPosition { get; }

Property Value

TextPosition:

The TextPosition at which the line starts.

int TabStopLevel { get; set; }

Property Value

int:

The tabstop level for the line.

string Text { get; set; }

Property Value

string:

The text of the line, excluding the line terminator.

Remarks

If more than one document line are encompassed on the view line, a single newline character will represent the line terminator.

Rect TextBounds { get; }

Property Value

Rect:

The bounds of the line within the view, excluding any margin space.

TextRange TextRangeIncludingLineTerminator { get; }

Property Value

TextRange:

The TextRange that indicates the text range of the line, including the line terminator if there is a hard line break on the line.

Size TextSize { get; }

Property Value

Size:

The Size of the line, excluding any margin space.

double TopMargin { get; }

Property Value

double:

The margin length above the line's text bounds.

double TranslationY { get; }

Property Value

double:

The amount by which the line was translated if the Change was Translated.

ITextView View { get; }

Property Value

ITextView:

The ITextView that this line is on.

TextViewLineVisibility Visibility { get; }

Property Value

TextViewLineVisibility:

A TextViewLineVisibility that indicates the visibility state of the line.

IEnumerable<TextSnapshotRange> VisibleSnapshotRanges { get; }

Property Value

IEnumerable<TextSnapshotRange>:

The collection of visible snapshot ranges on the line, including the line terminator if there is a hard line break on the line.

TextPosition VisibleStartPosition { get; }

Property Value

TextPosition:

The TextPosition of the first visible character or intra-text adornment on the line.

Remarks

This property may return a different value from StartPosition if there is collapsed text at the very start of the line without any intra-text adornment rendered in its place.

int WordWrapIndex { get; }

Property Value

int:

The vertical index of the line as displayed for the related ITextSnapshotLine.

Remarks

0 is returned if no word wrapping has occurred for the related ITextSnapshotLine at all. 0 is returned if there is word wrapping for the related ITextSnapshotLine, but this is the first view line within that group. 1 is returned for the second view line within that group, and so on.

int CharacterIndexToOffset(int characterIndex)

Parameter	Type	Description
characterIndex	int	The index of a character within the line.

Returns

int:

The offset for the specified character index within the line.

TextPosition CharacterIndexToPosition(int characterIndex)

Parameter	Type	Description
characterIndex	int	The index of a character within the line.

Returns

TextPosition:

The TextPosition for the specified character index within the line.

TextBounds GetCharacterBounds(TextPosition position)

Parameter	Type	Description
position	TextPosition	The TextPosition whose bounds need to be retrieved.

Returns

TextBounds:

A TextBounds containing the visible character bounds for the specified TextPosition.

TextBounds GetCharacterBounds(int offset)

Parameter	Type	Description
offset	int	The offset whose bounds need to be retrieved.

Returns

TextBounds:

A TextBounds containing the visible character bounds for the specified offset.

int GetCharacterColumn(TextPosition position)

Parameter	Type	Description
position	TextPosition	The TextPosition of the character whose column index is being requested.

Returns

int:

The column index within the view for the specified character.

int GetCharacterColumn(int offset)

Parameter	Type	Description
offset	int	The offset of the character whose column index is being requested.

Returns

int:

The column index within the view for the specified character.

IEnumerable<TagSnapshotRange<TTag>> GetIntraLineSpacerTags<TTag>() where TTag : IIntraLineSpacerTag

Type Parameters:

TTag -

The type of tag to look for.

Returns

IEnumerable<TagSnapshotRange<TTag>>:

A collection of intra-line spacer tag ranges on the line that are of the type TTag.

TextBounds GetIntraTextSpacerBounds(object tagKey)

Parameter	Type	Description
tagKey	object	The object used to uniquely identify the intra-text spacer.

Returns

TextBounds:

A TextBounds representing the bounds of the specified intra-text spacer.

TagSnapshotRange<IIntraTextSpacerTag> GetIntraTextSpacerTag(int characterIndex)

Parameter	Type	Description
characterIndex	int	The index of the character to examine.

Returns

TagSnapshotRange<IIntraTextSpacerTag>:

The intra-text spacer tag range on the line at the specified character, if the character represents an intra-text spacer.

Remarks

Spacer characters are embedded in between other real text characters. While spacer characters do take up a character index, they do not have a corresponding real character in a document.

IEnumerable<TagSnapshotRange<TTag>> GetIntraTextSpacerTags<TTag>() where TTag : IIntraTextSpacerTag

Type Parameters:

TTag -

The type of tag to look for.

Returns

IEnumerable<TagSnapshotRange<TTag>>:

A collection of intra-text spacer tag ranges on the line that are of the type TTag.

IEnumerable<TextBounds> GetTextBounds(TextPositionRange positionRange)

Parameter	Type	Description
positionRange	TextPositionRange	The TextPositionRange of the text for which to retrieve bounds.

Returns

IEnumerable<TextBounds>:

The collection of bounds for the specified TextPositionRange text.

Remarks

This method typically only returns more than one TextBounds if there is bi-directional text in the text range.

IEnumerable<TextBounds> GetTextBounds(TextRange textRange)

Parameter	Type	Description
textRange	TextRange	The TextRange of the text for which to retrieve bounds.

Returns

IEnumerable<TextBounds>:

The collection of bounds for the specified TextRange text.

Remarks

This method typically only returns more than one TextBounds if there is bi-directional text in the text range.

bool IsVirtualCharacter(int characterIndex, bool lineTerminatorsAreVirtual)

Parameter	Type	Description
characterIndex	int	The index of the character to examine.
lineTerminatorsAreVirtual	bool	Indicates whether to treat line terminators as virtual characters.

Returns

bool:

true if the character at the specified index is a virtual character; otherwise, false.

int LocationToCharacterIndex(double x, LocationToPositionAlgorithm algorithm)

Parameter	Type	Description
x	double	The x-coordinate for which to search.
algorithm	LocationToPositionAlgorithm	The LocationToPositionAlgorithm to use for calculation.

Returns

int:

The character index that contains the specified X location, in text area-relative coordinates.

int LocationToOffset(double x, LocationToPositionAlgorithm algorithm)

Parameter	Type	Description
x	double	The x-coordinate for which to search.
algorithm	LocationToPositionAlgorithm	The LocationToPositionAlgorithm to use for calculation.

Returns

int:

The offset that contains the specified X location, in text area-relative coordinates.

TextPosition LocationToPosition(double x, LocationToPositionAlgorithm algorithm)

Parameter	Type	Description
x	double	The x-coordinate for which to search.
algorithm	LocationToPositionAlgorithm	The LocationToPositionAlgorithm to use for calculation.

Returns

TextPosition:

The TextPosition that contains the specified X location, in text area-relative coordinates.

TextPosition LocationToPosition(double x, LocationToPositionAlgorithm algorithm, bool forceVirtualSpace)

Parameter	Type	Description
x	double	The x-coordinate for which to search.
algorithm	LocationToPositionAlgorithm	The LocationToPositionAlgorithm to use for calculation.
forceVirtualSpace	bool	Whether to force virtual space to be used (for block selections).

Returns

TextPosition:

The TextPosition that contains the specified X location, in text area-relative coordinates.

int OffsetToCharacterIndex(int offset)

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

Returns

int:

The character index that represents the specified offset within the line.

int PositionToCharacterIndex(TextPosition position)

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

Returns

int:

The character index that represents the specified TextPosition within the line.