Class WorkbookColorTransform

Defines color transforms for a WorkbookColorInfo instance.

Inheritance
System.Object
WorkbookColorTransform
Namespace: Infragistics.Documents.Excel
Assembly: IgniteUI.Blazor.Documents.Excel.dll
Syntax
public sealed class WorkbookColorTransform : Object
Remarks

This class is immutable.

Color transforms are not applicable to all contexts within which a WorkbookColorInfo is used; currently they are only used by WorksheetChart.

Constructors

WorkbookColorTransform(Nullable<Double>, Nullable<Double>, Nullable<Double>, Nullable<Double>)

Creates a new WorkbookColorTransform instance with the specified color transform values.

Declaration
public WorkbookColorTransform(Nullable<double> alpha = null, Nullable<double> luminanceModulation = null, Nullable<double> luminanceOffset = null, Nullable<double> shade = null)
Parameters
Type Name Description
System.Nullable<System.Double> alpha

The value of the Alpha property or null.
System.Nullable<System.Double> luminanceModulation

The value of the LuminanceModulation property or null.
System.Nullable<System.Double> luminanceOffset

The value of the LuminanceOffset property or null.
System.Nullable<System.Double> shade

The value of the Shade property or null.
Remarks

This class is immutable; as such, all properties are read-only.

Property values can only be specified at the time of instance creation.

Exceptions
Type Condition
System.ArgumentOutOfRangeException

alpha is outside the range of 0 to 1.0, inclusive.
See Also

Properties

Alpha

Defines the value of the alpha channel for the associated WorkbookColorInfo instance, expressed as a number between 0 and 1.

Declaration
public Nullable<double> Alpha { get; }
Property Value
Type Description
System.Nullable<System.Double>
Remarks

Use this property to control the transparency of the associated color.

For example, to make the associated color 50% transparent, assign a value of .5 to this property.

Assigning a value of null to this property implies that the associated color has no specific alpha channel setting, i.e., the associated color is fully opaque.

LuminanceModulation

Defines the luminance modulation for the associated WorkbookColorInfo instance, expressed as a fractional number.

Declaration
public Nullable<double> LuminanceModulation { get; }
Property Value
Type Description
System.Nullable<System.Double>
Remarks

Luminance is also referred to as brightness.

This property specifies the amount by which the luminance of the associated base color is increased. For example, a value of .5 yields a 50% reduction in luminance. A value of 1.0 implies no change in luminance. A value greater than 1.0 implies an increase in luminance; for example, a value of 2.0 doubles the luminance.

Assigning a value of null to this property implies that the associated color has no specific luminance modulation.

Luminance modulation is applied by converting the base color from RGB to HSL, then multiplying the luminance channel by the value of this property, then converting back to RGB.

See Also

LuminanceOffset

Defines the luminance offset for the associated WorkbookColorInfo instance, expressed as a fractional number.

Declaration
public Nullable<double> LuminanceOffset { get; }
Property Value
Type Description
System.Nullable<System.Double>
Remarks

Luminance is also referred to as brightness.

The luminance offset is applied by converting the base color from RGB to HSL, then the value of this property to the luminance channel, then converting back to RGB.

Assigning a value of null to this property implies that the associated color has no specific luminance offset.

See Also

Shade

Defines the shading for the associated WorkbookColorInfo instance, expressed as a fractional number.

Declaration
public Nullable<double> Shade { get; }
Property Value
Type Description
System.Nullable<System.Double>
See Also

See Also