| BackgroundColor Class |
Formatting that represents the background color of a field
Inheritance HierarchySystemObject
Sdl.FileTypeSupport.Framework.FormattingAbstractFormattingItem
Sdl.FileTypeSupport.Framework.FormattingBackgroundColor
Sdl.FileTypeSupport.Framework.FormattingAbstractFormattingItem
Sdl.FileTypeSupport.Framework.FormattingBackgroundColor
Namespace: Sdl.FileTypeSupport.Framework.Formatting
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2551.0)
SyntaxThe BackgroundColor type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BackgroundColor |
Constructs a background color with the default color (Window color from current Windows settings).
|
| BackgroundColor(Color) |
Creates formatting that represents a specific background color.
|
Properties| Name | Description | |
|---|---|---|
 | FormattingName |
The name of this type of formatting.
The default implementation returns the type name of the actual class,
but this can be overridden in derived classes.
(Inherited from AbstractFormattingItem.)The name may be used as an attribute name when storing this formatting in XML format, in which case the value of the attribute represents the StringValue property. |
| LocalizedFormattingName |
The localized name of this type of formatting
(Overrides AbstractFormattingItemLocalizedFormattingName.) |
| LocalizedStringValue |
Colors are serialized to localized strings either as named colors
(e.g. Aquamarine or ActiveWindowTitleText), or as 32-bit hex values
in the format determined by the .NET ColorConverter class.
(Overrides AbstractFormattingItemLocalizedStringValue.) |
 | Name |
The string used as name for this type of formatting.
|
| StringValue |
Colors are serialized to strings either as named colors
(e.g. Aquamarine or ActiveWindowTitleText), or as 32-bit hex values
in the format determined by the .NET ColorConverter class.
(Overrides AbstractFormattingItemStringValue.) |
| Value |
The color value of this formatting
|
Methods| Name | Description | |
|---|---|---|
| AcceptVisitor |
Calls VisitBackgroundColor(BackgroundColor) on the visitor.
(Overrides AbstractFormattingItemAcceptVisitor(IFormattingVisitor).) |
| Clone |
Clones this object
(Overrides AbstractFormattingItemClone.) |
| Equals |
Overridden to consider equivalent colors represented by different values equal
(Overrides AbstractFormattingItemEquals(Object).) |
| GetHashCode |
Overridden to return the same hash code for the same effective color values
(Overrides AbstractFormattingItemGetHashCode.) |
| ToString |
For debugging; returns "FormattingName = StringValue".
(Inherited from AbstractFormattingItem.) |
See AlsoCommunityComments