StandardTableKeyNames2.Definition Field

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.TableControl
Assembly:
Microsoft.VisualStudio.Shell.Framework.dll

Returns the definition associated with a symbol reference.

public: System::String ^ Definition;
std::wstring Definition;
public const string Definition;
val mutable Definition : string
Public Const Definition As String

Field Value

String

Remarks

The expected return type is IEntryBucket2.

The returned TryGetValue(String, Object) should return values for the following keys: 

StandardTableKeyNames.Text              Text associated with the defintion.
StandardTableKeyNames.DocumentName      Full path of the document containing the definition.
StandardTableKeyNames.Line              Line (0-based) of the defintion.
StandardTableKeyNames.Col               Column (0-based) of the defintion.

StandardTableKeyNames2.TextInlines     An enumeration of <xref data-throw-if-not-resolved="true" uid="System.Windows.Documents.Inline"></xref> to display formated text as part of the symbol definition [optional].
StandardTableKeyNames2.DefinitionIcon  An <xref data-throw-if-not-resolved="true" uid="Microsoft.VisualStudio.Imaging.Interop.ImageMoniker"></xref> to display with the symbol definition's text {optional].

Applies to