IVsLanguageTextOps.GetWordExtent Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the extent of a word or token on or near the point.

public:
 int GetWordExtent(Microsoft::VisualStudio::TextManager::Interop::IVsTextLayer ^ pTextLayer, Microsoft::VisualStudio::TextManager::Interop::TextAddress ta, Microsoft::VisualStudio::TextManager::Interop::WORDEXTFLAGS flags, cli::array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ pts);

public:
 int GetWordExtent(Microsoft::VisualStudio::TextManager::Interop::IVsTextLayer ^ pTextLayer, Microsoft::VisualStudio::TextManager::Interop::TextAddress ta, Microsoft::VisualStudio::TextManager::Interop::WORDEXTFLAGS flags, Platform::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ pts);

int GetWordExtent(Microsoft::VisualStudio::TextManager::Interop::IVsTextLayer const & pTextLayer, Microsoft::VisualStudio::TextManager::Interop::TextAddress ta, Microsoft::VisualStudio::TextManager::Interop::WORDEXTFLAGS flags, std::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> const & pts);

public int GetWordExtent (Microsoft.VisualStudio.TextManager.Interop.IVsTextLayer pTextLayer, Microsoft.VisualStudio.TextManager.Interop.TextAddress ta, Microsoft.VisualStudio.TextManager.Interop.WORDEXTFLAGS flags, Microsoft.VisualStudio.TextManager.Interop.TextSpan[] pts);

abstract member GetWordExtent : Microsoft.VisualStudio.TextManager.Interop.IVsTextLayer * Microsoft.VisualStudio.TextManager.Interop.TextAddress * Microsoft.VisualStudio.TextManager.Interop.WORDEXTFLAGS * Microsoft.VisualStudio.TextManager.Interop.TextSpan[] -> int

Public Function GetWordExtent (pTextLayer As IVsTextLayer, ta As TextAddress, flags As WORDEXTFLAGS, pts As TextSpan()) As Integer

Parameters

pTextLayer: IVsTextLayer

[in] An IVsTextLayer object representing the text file.

ta: TextAddress

[in] Specifies the text address of the characters to determine the word extent of. The text address is relative to the location of text within the text layer. For more information, see TextAddress.

flags: WORDEXTFLAGS

[in] Specifies options for determining the extent of a word. For more information, see WORDEXTFLAGS.

pts: TextSpan[]

[out] Returns the span of text identifying the whole word. For more information, see TextSpan.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsLanguageTextOps::GetWordExtent(  
   [in] IVsTextLayer *pTextLayer,   
   [in] TextAddress ta,   
   [in] WORDEXTFLAGS flags,   
   [out, retval] TextSpan *pts  
);

For this method, the environment passes in a text layer and a text address identifying a character position and flags identifying how the word extent should be determined. Your language service then decides the extent of the word based on this information and you can pass this information back to the environment in a text span structure (pts).

Applies to

Share via