Class TagPaintingProperties

In addition to implementing the ITagPaintingProperties interface this class also provides some simple operations to brighten and darken on colors.

Inheritance
System.Object
TagPaintingProperties
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Sdl.DesktopEditor.EditorApi.Implementation
Assembly: Sdl.DesktopEditor.EditorApi.dll
Syntax
public class TagPaintingProperties : ITagPaintingProperties

Constructors

TagPaintingProperties(Color, Color, Color)

TagPaintingProperties are a collection of color and style constants that are used for painting tag foregrounds, backgrounds, text, and edges.

By default tag backgrounds are gradients. Ghost tag background colors are calculated from normal tag background colors.

Declaration
public TagPaintingProperties(Color outlineColor, Color backgroundColor, Color textColor)
Parameters
Type Name Description
System.Drawing.Color outlineColor
System.Drawing.Color backgroundColor

This value is the lighter gradient parameter: the darker one is calculated.
System.Drawing.Color textColor

TagPaintingProperties(Color, Color, Color, Color)

TagPaintingProperties are a collection of color and style constants that are used for painting tag foregrounds, backgrounds, text, and edges.

By default tag backgrounds are shaded. Ghost tag background colors are calculated from normal tag background colors.

Declaration
public TagPaintingProperties(Color outlineColor, Color backgroundColor1, Color backgroundColor2, Color textColor)
Parameters
Type Name Description
System.Drawing.Color outlineColor
System.Drawing.Color backgroundColor1

The background color in the upper left.
System.Drawing.Color backgroundColor2

The background color in the lower right.
System.Drawing.Color textColor

TagPaintingProperties(Color, Color, Color, Color, FontStyle)

TagPaintingProperties are a collection of color and style constants that are used for painting tag foregrounds, backgrounds, text, and edges.

By default tag backgrounds are shaded. Ghost tag background colors are calculated from normal tag background colors.

Declaration
public TagPaintingProperties(Color outlineColor, Color backgroundColor1, Color backgroundColor2, Color textColor, FontStyle textFormatting)
Parameters
Type Name Description
System.Drawing.Color outlineColor
System.Drawing.Color backgroundColor1

The background color in the upper left.
System.Drawing.Color backgroundColor2

The background color in the lower right.
System.Drawing.Color textColor
System.Drawing.FontStyle textFormatting

Properties

BackgroundColor1

The background color to start painting the tag with. The tag will start with this color and gradually change into BackgroundColor2.

Declaration
public Color BackgroundColor1 { get; set; }
Property Value
Type Description
System.Drawing.Color

BackgroundColor2

The background color the finish painting the tag with. The tag will start with BackgroundColor1 and finish with this color.

Declaration
public Color BackgroundColor2 { get; set; }
Property Value
Type Description
System.Drawing.Color

GhostBackgroundColor

The color that will be used to paint the tag when it is a ghost tag.

Declaration
public Color GhostBackgroundColor { get; set; }
Property Value
Type Description
System.Drawing.Color

OutlineColor

The color that will be used to paint the tag border.

Declaration
public Color OutlineColor { get; set; }
Property Value
Type Description
System.Drawing.Color

TextColor

The color that will be used to paint the text that appears within the tag.

Declaration
public Color TextColor { get; set; }
Property Value
Type Description
System.Drawing.Color

TextFormatting

The font that will be used for the text within the tag.

Declaration
public FontStyle TextFormatting { get; set; }
Property Value
Type Description
System.Drawing.FontStyle

Methods

PopulateFromSettingsGroup(ISettingsGroup, String)

Populates this object with the settings contained in the provided settings group.

Declaration
public void PopulateFromSettingsGroup(ISettingsGroup settingsGroup, string settingId)
Parameters
Type Name Description
ISettingsGroup settingsGroup

The settings to populate from.
System.String settingId

The setting ID to use to load the settings.

SaveToSettingsGroup(ISettingsGroup, String)

Saves the current state of this object to the provided settings group.

Declaration
public void SaveToSettingsGroup(ISettingsGroup settingsGroup, string settingId)
Parameters
Type Name Description
ISettingsGroup settingsGroup

The settings group to save to.
System.String settingId

The setting ID to use to save the settings.

Implements

Extension Methods