Declarations.GetDisplayText(Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Package

Assembly:: Microsoft.VisualStudio.Package.LanguageService.14.0.dll

Assembly:: Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Package:: Microsoft.VisualStudio.Package.LanguageService.15.0 v17.12.40392

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.

When implemented in a derived class, gets the text to be displayed in the completion list for the specified item.

public:
 abstract System::String ^ GetDisplayText(int index);

public:
 abstract Platform::String ^ GetDisplayText(int index);

 abstract std::wstring GetDisplayText(int index);

public abstract string GetDisplayText (int index);

abstract member GetDisplayText : int -> string

Public MustOverride Function GetDisplayText (index As Integer) As String

Parameters

index: Int32

[in] The index of the item for which to get the display text.

Returns

String

The text to be displayed, otherwise null.

Remarks

The display text is shown in the list but it is the value returned from the GetName method that is inserted. It is also the value returned from GetName that is used in finding the best match. This allows the display text, for example, to include adornments such as surrounding "<" and ">" characters or show decorated names as used in C++.

Applies to

Partilhar via