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

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from ValueType.)

System_CAPS_pubmethodGetHashCode()

(Inherited from ValueType.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from ValueType.)

NameDescription
System_CAPS_pubfieldbBackgroundValid

BOOLEAN value indicating the background color is valid.

System_CAPS_pubfieldbFontFlagsValid

BOOLEAN value indicating the font flags are valid.

System_CAPS_pubfieldbForegroundValid

BOOLEAN value indicating the foreground color is valid.

System_CAPS_pubfieldcrBackground

DWORD specifying the background color.

System_CAPS_pubfieldcrForeground

DWORD specifying the foreground color.

System_CAPS_pubfielddwFontFlags

DWORD 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.

Return to top
Show: