VSTASKCOLUMN Structure

Article
02/04/2013

Column definitions for tasks.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

'Declaration
Public Structure VSTASKCOLUMN

public struct VSTASKCOLUMN

public value class VSTASKCOLUMN

[<Sealed>]
type VSTASKCOLUMN =  struct end

JScript supports the use of structures, but not the declaration of new ones.

The VSTASKCOLUMN type exposes the following members.

Methods

	Name	Description
	Equals	Indicates whether this instance and a specified object are equal. (Inherited from ValueType.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Inherited from ValueType.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns the fully qualified type name of this instance. (Inherited from ValueType.)

Top

Fields

	Name	Description
	bstrCanonicalName	String containing the non-localized name of the column header. It must be unique within this provider's column list.
	bstrHeading	String containing the text in header. bstrHeading may be nulla null reference (Nothing in Visual Basic) to indicate an image.
	bstrLocalizedName	String containing the localized name for the column header.
	bstrTip	String containing the tooltip for the column header.
	cxDefaultWidth	The default column width in pixels.
	cxMinWidth	The minimum column width in pixels.
	fAllowHide	Flag indicating whether the user is allowed to change the column's visibility.
	fAllowUserSort	Flag indicating whether the user is allowed to sort by clicking on the column's header.
	fDescendingSort	Flag indicating the column is sorted in descending order (default is ascending).
	fDynamicSize	Flag indicating whether the task list is allowed to resize the column automatically to make content fit better.
	fFitContent	Column will be automatically resized to fit whenever its content changes.
	fMoveable	Flag indicating whether the column may be dragged to another position by the user.
	fShowSortArrow	Flag indicating whether a sort arrow is shown in the header when the list is sorted by this column.
	fSizeable	Flag indicating whether the column may be resized by the user.
	fVisibleByDefault	Flag indicating whether this column is visible by default.
	iDefaultSortPriority	Specifies if a column is sorted by default.
	iField	The field index designated by the task provider.
	iImage	Index into the provider's image list.

Top

Remarks

These values are returned from GetColumn.

COM Signature

From vsshell80.idl:

typedef struct _VSTASKCOLUMN
{
    int     iField;
    BSTR    bstrHeading;
    int     iImage;
    BOOL    fShowSortArrow;
    BOOL    fAllowUserSort;
    BOOL    fVisibleByDefault;
    BOOL    fAllowHide;
    BOOL    fSizeable;
    BOOL    fMoveable;
    int     iDefaultSortPriority;
    BOOL    fDescendingSort;
    int     cxMinWidth;
    int     cxDefaultWidth;
    BOOL    fDynamicSize;
    BSTR    bstrCanonicalName;
    BSTR    bstrLocalizedName;
    BSTR    bstrTip;
    BOOL    fFitContent;
} VSTASKCOLUMN;

Thread Safety

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

Share via