ColorableItemInfo Structure

Provides information to a VSPackage about specific user-settable colorable item attributes of a Display Items that may have been modified by the user.

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

public struct ColorableItemInfo

The ColorableItemInfo type exposes the following members.

Public methodEqualsIndicates whether this instance and a specified object are equal. (Inherited from ValueType.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from ValueType.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns the fully qualified type name of this instance. (Inherited from ValueType.)

Public fieldbBackgroundValidBOOLEAN value indicating the background color is valid.
Public fieldbFontFlagsValidBOOLEAN value indicating the font flags are valid.
Public fieldbForegroundValidBOOLEAN value indicating the foreground color is valid.
Public fieldcrBackgroundDWORD specifying the background color.
Public fieldcrForegroundDWORD specifying the foreground color.
Public fielddwFontFlagsDWORD specifying the font flags

Not all information returned in a ColorableItemInfo structure may be valid because the Visual Studio IDE does not always store unmodified settings from the Font and Color property page in the registry. The bForegroundValid, bBackgroundValid,and bFontFlagsValid are set to non-zero (TRUE) when the corresponding value is valid.

Rather than supplying a literal RGB value, a VSPackage may express the color values in the crForeground and crBackground members in terms of a global palette. As well as simplifying implementation, this allows colors to track certain system-wide and environment-wide values. The interpretation of these color values is controlled by flags from the __VSCOLORTYPE enumeration.

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

Community Additions