ITableColumnDefinition Interface

Visual Studio 2015
 

Describes a column of data.

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

[CLSCompliantAttribute(false)]
public interface class ITableColumnDefinition

NameDescription
System_CAPS_pubpropertyColumnDefinition

Gets the width of the item in the table's header (which is inherited by the corresponding columns of the entries).

System_CAPS_pubpropertyComparer

Gets the StringComparer used to sort and compare entries in this column. This value is used for the filtering, sorting and grouping.

System_CAPS_pubpropertyDefaultVisible

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.

System_CAPS_pubpropertyDisplayImage

ImageMoniker shown for this column in the header.

System_CAPS_pubpropertyDisplayName

Localized name of the column.

System_CAPS_pubpropertyFilterPresets

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

System_CAPS_pubpropertyHeaderName

Localized name used when adding headers to entries copied from the control to the clipboard.

System_CAPS_pubpropertyIsCopyable

Indicates whether the user can copy the column's content using the default copy command.

System_CAPS_pubpropertyIsFilterable

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.

System_CAPS_pubpropertyIsHideable

Indicates whether the user can hide the column using the default UI.

System_CAPS_pubpropertyIsMovable

Indicates whether the user can move the column using the default UI.

System_CAPS_pubpropertyIsResizable

Indicates whether the user can change the column's width using the default UI.

System_CAPS_pubpropertyIsSortable

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.

System_CAPS_pubpropertyMaxWidth

Maximum width of the column (in pixels).

System_CAPS_pubpropertyMinWidth

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.

System_CAPS_pubpropertyName

Unique identifier of the column. This value must match the value provided by the Name attribute.

System_CAPS_pubpropertyTextWrapping

Indicates whether the user can copy the column's content should be wrapped if it is too large to fit.

NameDescription
System_CAPS_pubmethodCompareContent(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.

System_CAPS_pubmethodCreateBucketForEntry(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.

System_CAPS_pubmethodTryCreateColumnContent(ITableEntryHandle^, Boolean, FrameworkElement^)

Get the data for this column of an ITableEntryHandle as an FrameworkElement. The default implementation fails to return a FrameworkElement.

System_CAPS_pubmethodTryCreateImageContent(ITableEntryHandle^, Boolean, ImageMoniker)

Get the data for this column of an ITableEntryHandle as an ImageMoniker. The default implementation fails to return an ImageMoniker.

System_CAPS_pubmethodTryCreateStringContent(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.

System_CAPS_pubmethodTryCreateToolTip(ITableEntryHandle^, Object^)

Get the tool tip for this column of an ITableEntryHandle. The default implementation returns false and sets toolTip to null.

Required MEF metadata: Name

Return to top
Show: