AllColorableItemInfo Structure

Use to specify all the attributes of Display Items to the Visual Studio environment.

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

Syntax

'Declaration
Public Structure AllColorableItemInfo
public struct AllColorableItemInfo
public value class AllColorableItemInfo
[<Sealed>]
type AllColorableItemInfo =  struct end
JScript supports the use of structures, but not the declaration of new ones.

The AllColorableItemInfo type exposes the following members.

Methods

  Name Description
Public method Equals Indicates whether this instance and a specified object are equal. (Inherited from ValueType.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from ValueType.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method ToString Returns the fully qualified type name of this instance. (Inherited from ValueType.)

Top

Fields

  Name Description
Public field bAutoBackgroundValid Indicates whether crAutoBackground contains a valid color value.
Public field bAutoForegroundValid Indicates whether crAutoForeground contains a valid color value.
Public field bDescriptionValid Indicates the bstrDescription contains a valid description string
Public field bFlagsValid Indicates whether fFlags contains valid font flags from __FCITEMFLAGS.
Public field bLineStyleValid Indicates whether eLineStyle contains a valid line style.
Public field bLocalizedNameValid Indicates whether bstrLocalizedName contains a valid localized name string.
Public field bMarkerVisualStyleValid Indicates whether dwMarkerVisualStyle contains a valid marker style.
Public field bNameValid Indicates whether bstrName contains a valid (non-localized) name string.
Public field bstrDescription String that contains a brief description of the item displayed as a ToolTip. (This feature is currently disabled).
Public field bstrLocalizedName String that contains the localized name of the item displayed to the user.
Public field bstrName String that contains the non-localized name of the item used internally by the VSPackage to compare and merge.
Public field crAutoBackground Specifies the automatic background color for an item.
Public field crAutoForeground Specifies the automatic foreground color for an item.
Public field dwMarkerVisualStyle Specifies the visual style of the marker
Public field eLineStyle Specifies the line style for marker items.
Public field fFlags Specifies attributes of an item.
Public field Info Specifies the foreground color, background color, and font flags from the ColorableItemInfo structure.

Top

Remarks

Stored information returned in a AllColorableItemInfo structure may beinvalid because the IDE (integrated development environment) does not always store settings unmodified by an end-user's use of the Font and Color property page in the registry.

An instance of the AllColorableItemInfo structure can contain any of the color representations enumerated in __VSCOLORTYPE.

Use the member methods of the IVsFontAndColorUtilities class to examine and manipulate color and font information in an instance of AllColorableItemInfo.

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.

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace