StandardTableKeyNames Class

Visual Studio 2015
 

Names of predefined keys for data in an ITableEntry.

Namespace:   Microsoft.VisualStudio.Shell.TableManager
Assembly:  Microsoft.VisualStudio.Shell.Immutable.14.0 (in Microsoft.VisualStudio.Shell.Immutable.14.0.dll)

System::Object
  Microsoft.VisualStudio.Shell.TableManager::StandardTableKeyNames

public ref class StandardTableKeyNames abstract sealed 

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticBuildTool

The name of the tool that generated the error (e.g. "fxcop"). Expected data type is string.

System_CAPS_pubfieldSystem_CAPS_staticColumn

The column number associated with a table-entry. The raw value should be an integer. The first column of a line should be column 0.

System_CAPS_pubfieldSystem_CAPS_staticDetailsExpander

The details expander associated with a table-entry.

System_CAPS_pubfieldSystem_CAPS_staticDocumentName

The full path of the document associated with a table-entry. The raw value should be string.

System_CAPS_pubfieldSystem_CAPS_staticErrorCategory

The error category. Expected data type type is string (e.g. "Compiler").

System_CAPS_pubfieldSystem_CAPS_staticErrorCode

The text displayed in the StandardTableColumnDefinitions.ErrorCode column. Expected data type is string (e.g. "CS1591"). If this value is not set, then the column will be left blank.

System_CAPS_pubfieldSystem_CAPS_staticErrorCodeToolTip

The tooltip displayed in the StandardTableColumnDefinitions.ErrorCode column. Expected data type is string.

System_CAPS_pubfieldSystem_CAPS_staticErrorRank

The ranking of the error compared with other errors. Expected data type is ErrorRank .Errors with the lowest rank are, by default, displayed first in the error list.

System_CAPS_pubfieldSystem_CAPS_staticErrorSeverity

The error severity (despite the expected data type of the value). Expected data type is __VSERRORCATEGORY.

System_CAPS_pubfieldSystem_CAPS_staticErrorSeverityImage

The icon used to indicate the error severity. Expected data type is Imaging.Interop.ImageMoniker.

System_CAPS_pubfieldSystem_CAPS_staticErrorSource

The entry's error source (e.g. "Build"). Expected data type is ErrorSource.

System_CAPS_pubfieldSystem_CAPS_staticFullText

The full text associated with a table-entry in the case when StandardTableKeyNames.Text is truncated. The raw value should be string. If StandardTableKeyNames.Text has not been truncated, then attempts to get the value for this key should fail. If StandardTableKeyNames.Text has been truncated, then this value should contain the all of the truncated text (along with whatever text was removed).

System_CAPS_pubfieldSystem_CAPS_staticHasVerticalContent

Definition for whether a table-entry has vertical content. The raw value should be a boolean.

System_CAPS_pubfieldSystem_CAPS_staticHelpKeyword

Help keyword of the help associated with this table entry. Expected data type is string. VS will, first, try to display help using the keyword. If that fails, it will try to open the link specified in StandardTableKeyNames.HelpLink.

System_CAPS_pubfieldSystem_CAPS_staticHelpLink

URI of the help associated with this table entry. Expected data type is string. This entry will be used to open a URI if the either the entry has no StandardTableKeyNames.HelpKeyword or attempting to use the keyword to open help fails.

System_CAPS_pubfieldSystem_CAPS_staticImageIndex

The IVsTaskItem.ImageListIndex() of the error (for errors reported using the legacy APIs).

System_CAPS_pubfieldSystem_CAPS_staticIsActiveContext

Was the error generated from the active context? If this value is set, then the text associated with the StandardTableColumnDefinitions.ErrorSeverity will have "(active)" or " (inactive)" appended to it, depending on the value. The expected data type is bool.

System_CAPS_pubfieldSystem_CAPS_staticLine

The line number associated with a table-entry. The raw value should be an integer. The first line of a file should be line 0.

System_CAPS_pubfieldSystem_CAPS_staticOutputWindowMessageId

The message ID that is used to associate an entry in the error list with a text message in the output window. The expected value data type is uint.

System_CAPS_pubfieldSystem_CAPS_staticOutputWindowMessageProvider

System_CAPS_pubfieldSystem_CAPS_staticPriority

The error priority. Expected data type is VSTASKPRIORITY.

System_CAPS_pubfieldSystem_CAPS_staticPriorityImage

The icon used to indicate the error priority. Expected data type is Imaging.Interop.ImageMoniker.

System_CAPS_pubfieldSystem_CAPS_staticProjectGuid

The Guid of the project. Expected data type is Guid.Use IVsSolution.GetGuidOfProject to get the project's Guid from an IVsHierarchy. Performance will be improved if you "prebox" your Guid by, in your ITableEntry or ITableEntriesSnapshot, having a member variable private object boxedProjectGuid = projectGuid; and returning boxedProjectGuid instead of projectGuid.

System_CAPS_pubfieldSystem_CAPS_staticProjectName

The name of the project. Expected data type is string (e.g. "ConsoleApplication1").

System_CAPS_pubfieldSystem_CAPS_staticTaskCategory

The category of the item. Expected data type is VSTASKCATEGORY.

System_CAPS_pubfieldSystem_CAPS_staticText

The text associated with a table-entry. The raw value should be string. The length of this text should be constrained to what fits nicely in the error list. If it is too long, you should truncate text to something reasonable and return the untruncated text in StandardTableKeyNames.FullText.

These constants should only be used to get data from an ITableEntry. They should not be used when calling declaring what columns should be displayed when a provider is active. Use StandardTableColumnDefinitions for those.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: