ITableColumnDefinition Interface

Definition

Namespace:

Microsoft.VisualStudio.Shell.TableControl

Assembly:

Microsoft.VisualStudio.Shell.Framework.dll

Important

This API is not CLS-compliant.

Describes a column of data.

public interface class ITableColumnDefinition

public interface class ITableColumnDefinition

__interface ITableColumnDefinition

public interface ITableColumnDefinition

type ITableColumnDefinition = interface

Public Interface ITableColumnDefinition

Derived

Microsoft.VisualStudio.Shell.TableControl.ITableColumnDefinition2

Microsoft.VisualStudio.Shell.TableControl.TableColumnDefinitionBase

Remarks

Required MEF metadata: Name.

Properties

ColumnDefinition	Gets the width of the item in the table's header (which is inherited by the corresponding columns of the entries).
Comparer	Gets the StringComparer used to sort and compare entries in this column. This value is used for the filtering, sorting and grouping.
DefaultVisible	Indicates whether the column is visible by default. If this returns false then the column will be hidden the first time there is data in the table that could be shown using this column.
DisplayImage	ImageMoniker shown for this column in the header.
DisplayName	Localized name of the column.
FilterPresets	The strings that always exist as filterable items for this list. For example, if you want to always show "Errors", "Warnings" and "Messages" as filtering
HeaderName	Localized name used when adding headers to entries copied from the control to the clipboard.
IsCopyable	Indicates whether the user can copy the column's content using the default copy command.
IsFilterable	Indicates whether the column can be filtered using the default UI. If this returns false then there will be no built-in UI for letting the user filter the column.
IsHideable	Indicates whether the user can hide the column using the default UI.
IsMovable	Indicates whether the user can move the column using the default UI.
IsResizable	Indicates whether the user can change the column's width using the default UI.
IsSortable	Indicates whether the column can be sorted using the default UI. If this returns false then there will be no built-in UI for letting the user sort the column.
MaxWidth	Maximum width of the column (in pixels).
MinWidth	Minumum width of the column (in pixels). The minimum width is 22 pixels (so that there is space to display the sorting and filtering UI.
Name	Unique identifier of the column. This value must match the value provided by the Name attribute.
TextWrapping	Indicates whether the user can copy the column's content should be wrapped if it is too large to fit.

Methods

CompareContent(ITableEntryHandle, ITableEntryHandle)	Compare the sort order of two entries of the data in one column of two different entries. The default comparisons does a ITableEntry.TryGetValue(string, out object) using the column name as the key. If the left and right values are strings, then the strings are compared. If they are < IComparables and the same underlying type, then IComparable.CompareTo(object) is used. Otherwise we get the string content for this column and compare those.
CreateBucketForEntry(ITableEntryHandle)	Get the IEntryBucket associated this this column for this entry. The identity of a bucket is based on object.GetHashCode() and object.Equals() two entries that return different objects for their bucket will be grouped together as long as the two buckets are equivalent. This method is unused at the moment.
TryCreateColumnContent(ITableEntryHandle, Boolean, FrameworkElement)	Get the data for this column of an ITableEntryHandle as an FrameworkElement. The default implementation fails to return a FrameworkElement.
TryCreateImageContent(ITableEntryHandle, Boolean, ImageMoniker)	Get the data for this column of an ITableEntryHandle as an ImageMoniker. The default implementation fails to return an ImageMoniker.
TryCreateStringContent(ITableEntryHandle, Boolean, Boolean, String)	Get the data for this column of an ITableEntryHandle as a string. The default implementation is to get the value using Name as a key and, if it is a string, display that.
TryCreateToolTip(ITableEntryHandle, Object)	Get the tool tip for this column of an ITableEntryHandle. The default implementation returns false and sets toolTip to null.