ITextSnapshot Interface

public interface ITextSnapshot : ITextRangeProvider

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

Boolean:

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; }

Parameter	Type	Description
index	Int32	The index of the character to return.

Property Value

Char:

A character in the snapshot.

int Length { get; }

Property Value

Int32:

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)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.

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)

Parameter	Type	Description
type	ITextChangeType	An ITextChangeType specifying the type of change.
options	ITextChangeOptions	The ITextChangeOptions for the change.

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)

Parameter	Type	Description
exporter	ITextExporter	The ITextExporter to use for the export operation.

Returns

String:

The exported text.

void ExportToFile(ITextExporter exporter, string path)

Parameter	Type	Description
exporter	ITextExporter	The ITextExporter to use for the export operation.
path	String	The full path of the file of which to save.

ISearchResultSet FindAll(ISearchOptions options)

Parameter	Type	Description
options	ISearchOptions	The ISearchOptions to use.

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

ISearchResultSet FindAll(ISearchOptions options, TextRange searchTextRange)

Parameter	Type	Description
options	ISearchOptions	The ISearchOptions to use.
searchTextRange	TextRange	The TextRange of offsets to search. If all should be searched, specify the range 0 to the length of the snapshot.

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

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

Parameter	Type	Description
options	ISearchOptions	The ISearchOptions to use.
startOffset	Int32	The offset at which to start the search.
canWrap	Boolean	Whether the search can wrap at the end of the search text range.

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

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

Parameter	Type	Description
options	ISearchOptions	The ISearchOptions to use.
startOffset	Int32	The offset at which to start the search.
canWrap	Boolean	Whether the search can wrap at the end of the search text range.
searchTextRange	TextRange	The TextRange of offsets to search. If all should be searched, specify the range 0 to the length of the ITextSnapshot.

Returns

ISearchResultSet:

An ISearchResultSet that specifies the result of the operation.

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

Parameter	Type	Description
options	ISearchOptions	The ISearchOptions to use.
startOffset	Int32	The offset at which to start the search.
canWrap	Boolean	Whether the search can wrap at the end of the search text range.
searchTextRange	TextRange	The TextRange of offsets to search. If all should be searched, specify the range 0 to the length of the ITextSnapshot.
cancellationToken	CancellationToken	The cancellation token that can abort the search operation.

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)

Parameter	Type	Description
position	TextPosition	The TextPosition at which to initalize the reader.

Returns

ITextSnapshotReader:

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

ITextSnapshotReader GetReader(int offset)

Parameter	Type	Description
offset	Int32	The offset at which to initalize the reader.

Returns

ITextSnapshotReader:

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

string GetSubstring(TextRange textRange)

Parameter	Type	Description
textRange	TextRange	A TextRange indicating the range of text to retrieve.

Returns

String:

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

string GetSubstring(TextRange textRange, LineTerminator lineTerminator)

Parameter	Type	Description
textRange	TextRange	A TextRange indicating the range of text to retrieve.
lineTerminator	LineTerminator	A LineTerminator specifying the type of line terminators to use.

Returns

String:

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

string GetSubstring(int offset, int length)

Parameter	Type	Description
offset	Int32	The offset at which to retrieve the text.
length	Int32	The number of characters to return.

Returns

String:

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

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

Parameter	Type	Description
offset	Int32	The offset at which to retrieve the text.
length	Int32	The number of characters to return.
lineTerminator	LineTerminator	A LineTerminator specifying the type of line terminators to use.

Returns

String:

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

string GetText(LineTerminator lineTerminator)

Parameter	Type	Description
lineTerminator	LineTerminator	A LineTerminator specifying the type of line terminators to use.

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)

Parameter	Type	Description
offset	Int32	The offset to examine.

Returns

String:

The text of the word at the specified offset.

string GetWordText(int offset, TextOffsetAffinity affinity)

Parameter	Type	Description
offset	Int32	The offset to examine.
affinity	TextOffsetAffinity	The TextOffsetAffinity to use.

Returns

String:

The text of the word at the specified offset.

TextRange GetWordTextRange(int offset)

Parameter	Type	Description
offset	Int32	The offset to examine.

Returns

TextRange:

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

TextRange GetWordTextRange(int offset, TextOffsetAffinity affinity)

Parameter	Type	Description
offset	Int32	The offset to examine.
affinity	TextOffsetAffinity	The TextOffsetAffinity to use.

Returns

TextRange:

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

TextPosition OffsetToPosition(int offset)

Parameter	Type	Description
offset	Int32	The offset of a character within the snapshot.

Returns

TextPosition:

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

TextRange PositionRangeToTextRange(TextPositionRange positionRange)

Parameter	Type	Description
positionRange	TextPositionRange	The TextPositionRange within the snapshot.

Returns

TextRange:

The TextRange that represents the specified TextPositionRange within the snapshot.

int PositionToOffset(TextPosition position)

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

Returns

Int32:

The offset for the specified TextPosition within the text lines.

TextPositionRange TextRangeToPositionRange(TextRange textRange)

Parameter	Type	Description
textRange	TextRange	The TextRange within the snapshot.

Returns

TextPositionRange:

The TextPositionRange that represents the specified TextRange within the snapshot.