Share via


ITextStructureNavigator.GetExtentOfWord Method

Gets the extent of the word at the given position.

Namespace:  Microsoft.VisualStudio.Text.Operations
Assembly:  Microsoft.VisualStudio.Text.Logic (in Microsoft.VisualStudio.Text.Logic.dll)

Syntax

'Declaration
Function GetExtentOfWord ( _
    currentPosition As SnapshotPoint _
) As TextExtent
TextExtent GetExtentOfWord(
    SnapshotPoint currentPosition
)
TextExtent GetExtentOfWord(
    SnapshotPoint currentPosition
)
abstract GetExtentOfWord : 
        currentPosition:SnapshotPoint -> TextExtent
function GetExtentOfWord(
    currentPosition : SnapshotPoint
) : TextExtent

Parameters

Return Value

Type: Microsoft.VisualStudio.Text.Operations.TextExtent
A TextExtent that represents the word.

Remarks

IsSignificant should be set to false for words consisting only of whitespace, unless the whitespace is a significant part of the document. If the returned extent consists only of insignificant whitespace, it should include all of the adjacent whitespace, including newline characters, spaces, and tabs.

.NET Framework Security

See Also

Reference

ITextStructureNavigator Interface

Microsoft.VisualStudio.Text.Operations Namespace