StandardTableKeyNames Class

Definition

Namespace:

Microsoft.VisualStudio.Shell.TableManager

Assembly:

Microsoft.VisualStudio.Shell.Framework.dll

Names of predefined keys for data in an ITableEntry.

public ref class StandardTableKeyNames abstract sealed

public ref class StandardTableKeyNames abstract sealed

class StandardTableKeyNames abstract sealed

public static class StandardTableKeyNames

type StandardTableKeyNames = class

Public Class StandardTableKeyNames

Inheritance

Object

StandardTableKeyNames

Remarks

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.

Fields

Branch	The branch of the code repository associated with the entry.
BuildTool	The name of the tool that generated the error (e.g. "fxcop"). Expected data type is string.
Column	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.
Definition	Returns the definition associated with a symbol reference.
DefinitionIcon	Returns an icon to display as part of the definition.
DetailsExpander	The details expander associated with a table-entry.
DisplayPath	The full displayed path for the entry.
DocumentName	The full path of the document associated with a table-entry. The raw value should be string.
ErrorCategory	The error category. Expected data type type is string (e.g. "Compiler").
ErrorCode	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.
ErrorCodeToolTip	The tooltip displayed in the StandardTableColumnDefinitions.ErrorCode column. Expected data type is string.
ErrorRank	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.
ErrorSeverity	The error severity (despite the expected data type of the value). Expected data type is __VSERRORCATEGORY.
ErrorSeverityImage	The icon used to indicate the error severity. Expected data type is Imaging.Interop.ImageMoniker.
ErrorSource	The entry's error source (e.g. "Build"). Expected data type is ErrorSource.
FullText	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).
HasVerticalContent	Definition for whether a table-entry has vertical content. The raw value should be a boolean.
HelpKeyword	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.
HelpLink	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.
HelpText	Returns a help text associated with the table entry.
ImageIndex	The IVsTaskItem.ImageListIndex() of the error (for errors reported using the legacy APIs).
IsActiveContext	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.
ItemOrigin	The origin of the entry.
Line	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.
LineText	Returns a plain text for an error or symbol reference.
NameSpace	Returns the namespace containing the error or symbol reference.
OutputWindowMessageId	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.
OutputWindowMessageProvider
Path	Returns the path of the file containing the error or symbol reference.
PersistentSpan	The location associated with the entry. It enables accurate navigation when data provided by Line and Column is stale after making changes to the document.
Priority	The error priority. Expected data type is VSTASKPRIORITY.
PriorityImage	The icon used to indicate the error priority. Expected data type is Imaging.Interop.ImageMoniker.
ProjectGuid	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.
ProjectGuids	Returns the IDs of the projects that contain the error.
ProjectName	The name of the project. Expected data type is string (e.g. "ConsoleApplication1").
ProjectNames	Returns the names of the projects that contain the error.
Repository	The code repository associated with the entry.
SuppressionState	The suppression state of an error.
SymbolKind	The symbol kind associated with the entry.
TaskCategory	The category of the item. Expected data type is VSTASKCATEGORY.
Text	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.
TextInlines	Returned a list of Inline used to display formatted text for an error or symbol.