ITextSnapshot Interface

ITextDocument Document { get; }

Property Value

ITextDocument:

The ITextDocument for which this snapshot applies.

string FooterText { get; }

Property Value

string:

The footer text to append to the end of the snapshot's Text.

Remarks

The use of this property, along with HeaderText, allows for editing 'fragments' of code.
The header and footer sections provide the outer code that surrounds the 'fragment' being edited in the snapshot's Text property.

An example is when editing a method body in a language like C#. The HeaderText would contain the namespace, class, and member declaration starts. The FooterText would contain the namespace, class, and member declaration ends. The document would edit the 'fragment' of statements within the header and footer, and all of them would be combined for parsing purposes.

See Also

• GetMergedBufferReader()
• HeaderText
• Text

bool HasContent { get; }

Property Value

bool:

true if there is content in the snapshot; otherwise, false.

Remarks

This property simply checks whether the snapshot has a length greater than 0.

string HeaderText { get; }

Property Value

string:

The header text to append to the start of the snapshot's Text.

Remarks

The use of this property, along with FooterText, allows for editing 'fragments' of code.
The header and footer sections provide the outer code that surrounds the 'fragment' being edited in the snapshot's Text property.

An example is when editing a method body in a language like C#. The HeaderText would contain the namespace, class, and member declaration starts. The FooterText would contain the namespace, class, and member declaration ends. The document would edit the 'fragment' of statements within the header and footer, and all of them would be combined for parsing purposes.

See Also

• GetMergedBufferReader()
• HeaderText
• Text

char this[int index] { get; }

Property Value

char:

A character in the snapshot.

int Length { get; }

Property Value

int:

The number of characters in the snapshot, excluding any carriage-returns but including newlines.

ITextSnapshotLineCollection Lines { get; }

Property Value

ITextSnapshotLineCollection:

A ITextSnapshotLineCollection containing the lines in the snapshot.

TextSnapshotRange SnapshotRange { get; }

Property Value

TextSnapshotRange:

A TextSnapshotRange that contains the entire text snapshot.

string Text { get; }

Property Value

string:

The entire text of the snapshot using CarriageReturnNewline for line ends.

Remarks

This property should not be used as input for language parsers or taggers since internally for performance reasons, text is stored with newlines-only as line terminators. Instead, call GetText(LineTerminator) with the Newline parameter when needing the text for parsing or tagging reasons.

The GetText(LineTerminator) method can be used to obtain text using any of the LineTerminator options.

ITextVersion Version { get; }

Property Value

ITextVersion:

The ITextVersion that specifies the text version represented by the snapshot.

ITextChange CreateTextChange(ITextChangeType type)

Returns

ITextChange:

The ITextChange that was created.

Remarks

The ITextChange.Apply() method must be called to apply the queued operations to the document.

ITextChange CreateTextChange(ITextChangeType type, ITextChangeOptions options)

Returns

ITextChange:

The ITextChange that was created.

Remarks

The ITextChange.Apply() method must be called to apply the queued operations to the document.

string Export(ITextExporter exporter)

Returns

string:

The exported text.

ISearchResultSet FindAll(ISearchOptions options)

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

ISearchResultSet FindAll(ISearchOptions options, TextRange searchTextRange)

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

ISearchResultSet FindNext(ISearchOptions options, int startOffset, bool canWrap)

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

ISearchResultSet FindNext(ISearchOptions options, int startOffset, bool canWrap, TextRange searchTextRange)

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

ISearchResultSet FindNext(ISearchOptions options, int startOffset, bool canWrap, TextRange searchTextRange, CancellationToken cancellationToken)

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

ITextBufferReader GetMergedBufferReader()

Returns

ITextBufferReader:

An ITextBufferReader that allows scanning over a union of the HeaderText, Text, and FooterText.

See Also

• FooterText
• HeaderText
• Text

ITextSnapshotReader GetReader(TextPosition position)

Returns

ITextSnapshotReader:

An ITextSnapshotReader that can be used to navigate through the text and token contents of the snapshot.

ITextSnapshotReader GetReader(int offset)

Returns

ITextSnapshotReader:

An ITextBufferReader that can be used to navigate through the text and token contents of the snapshot.

string GetSubstring(TextRange textRange)

Returns

string:

The substring from the snapshot text using CarriageReturnNewline for line ends.

string GetSubstring(TextRange textRange, LineTerminator lineTerminator)

Returns

string:

The substring from the snapshot text using the specified LineTerminator for line ends.

string GetSubstring(int offset, int length)

Returns

string:

The substring from the snapshot text using CarriageReturnNewline for line ends.

string GetSubstring(int offset, int length, LineTerminator lineTerminator)

Returns

string:

The substring from the snapshot text using the specified LineTerminator for line ends.

string GetText(LineTerminator lineTerminator)

Returns

string:

The entire text of the snapshot using the specified LineTerminator for line ends.

Remarks

To retrieve the text in the format expected by a language parser or tagger, pass Newline as the lineTerminator parameter.

ITextStatistics GetTextStatistics()

Returns

ITextStatistics:

An ITextStatistics for the snapshot's text.

string GetWordText(int offset)

Returns

string:

The text of the word at the specified offset.

string GetWordText(int offset, TextOffsetAffinity affinity)

Returns

string:

The text of the word at the specified offset.

TextRange GetWordTextRange(int offset)

Returns

TextRange:

A TextRange containing a range of offsets that contain the word at the specified offset.

TextRange GetWordTextRange(int offset, TextOffsetAffinity affinity)

Returns

TextRange:

A TextRange containing a range of offsets that contain the word at the specified offset.

TextPosition OffsetToPosition(int offset)

Returns

TextPosition:

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

TextRange PositionRangeToTextRange(TextPositionRange positionRange)

Returns

TextRange:

The TextRange that represents the specified TextPositionRange within the snapshot.

int PositionToOffset(TextPosition position)

Returns

int:

The offset for the specified TextPosition within the text lines.

TextPositionRange TextRangeToPositionRange(TextRange textRange)

Returns

TextPositionRange:

The TextPositionRange that represents the specified TextRange within the snapshot.