Interface ITagPaintingProperties

This interface provides the properties used when painting tags in the document.

Namespace: Sdl.DesktopEditor.EditorApi
Assembly: Sdl.DesktopEditor.EditorApi.dll
Syntax
public interface ITagPaintingProperties

Properties

BackgroundColor1

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

Declaration
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
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
Color GhostBackgroundColor { get; set; }
Property Value
Type Description
System.Drawing.Color

OutlineColor

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

Declaration
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
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
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
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 save the settings.

SaveToSettingsGroup(ISettingsGroup, String)

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

Declaration
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 load the settings.

Extension Methods