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)
Syntax
'Declaration
Public Structure ColorableItemInfo
public struct ColorableItemInfo
public value class ColorableItemInfo
[<Sealed>]
type ColorableItemInfo = struct end
JScript supports the use of structures, but not the declaration of new ones.
The ColorableItemInfo type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType.) |
|
GetHashCode | Returns the hash code for this instance. (Inherited from ValueType.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
ToString | Returns the fully qualified type name of this instance. (Inherited from ValueType.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Public field") |
bBackgroundValid | BOOLEAN value indicating the background color is valid. |
|
bFontFlagsValid | BOOLEAN value indicating the font flags are valid. |
|
bForegroundValid | BOOLEAN value indicating the foreground color is valid. |
|
crBackground | DWORD specifying the background color. |
|
crForeground | DWORD specifying the foreground color. |
|
dwFontFlags | DWORD specifying the font flags |
Top
Remarks
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.
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.