Class BaseColorField

Inheritance
System.Object
BaseColorField
ColorField
Hue
Luminance
Saturation
Implements
Namespace: IronPPT.Models
Assembly: IronPPT.dll
Syntax
public abstract class BaseColorField : Object, IBaseColorField

Scaling or shifting one color channel in IronPPT runs through the shape BaseColorField defines. It gives a channel value the modulation and offset that let a color be adjusted relatively instead of set to a flat number. You rarely name it directly: a concrete ColorField (the red, green, or blue channel of a Color) is the type you handle, and the adjustment members live on this shared base.

Two properties live here. Modulation is an IPercentage that scales the channel value, and Offset is an IPercentage that shifts it, both expressed as percentages so a theme color can be lightened or darkened consistently. Because BaseColorField is abstract, you work through a derived type such as ColorField, reading or assigning these properties when a color needs a relative adjustment instead of an absolute value. For straightforward solid colors, set the channel value on ColorField and leave modulation and offset alone.

The paragraph style example shows where styled color is applied, and the add text how-to covers formatting text runs.

Constructors

BaseColorField()

Declaration
protected BaseColorField()

Properties

Modulation

Declaration
public IPercentage Modulation { get; set; }
Property Value
Type Description
IPercentage

Offset

Declaration
public IPercentage Offset { get; set; }
Property Value
Type Description
IPercentage

Implements