Class ExcelColorTransformCollection
Color transformation
Inheritance
Implements
Inherited Members
Namespace: OfficeOpenXml.Drawing.Style.Coloring
Assembly: EPPlus.dll
Syntax
public class ExcelColorTransformCollection : IEnumerable<IColorTransformItem>, IEnumerableProperties
Count
Number of items in the collection
Declaration
public int Count { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Item[Int32]
Indexer for the colletion
Declaration
public IColorTransformItem this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The position in the list |
Property Value
| Type | Description |
|---|---|
| IColorTransformItem |
Methods
AddAlpha(Double)
The opacity as expressed by a percentage value Alpha equals 100-Transparancy
Declaration
public void AddAlpha(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The alpha value in percentage 0-100 |
AddAlphaModulation(Double)
Specifies a more or less opaque version of its input color Alpha equals 100-Transparancy
Declaration
public void AddAlphaModulation(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The alpha modulation in a positive percentage |
AddAlphaOffset(Double)
Adds an alpha offset value.
Declaration
public void AddAlphaOffset(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The tint percentage. From 0-100 |
AddBlue(Double)
Specifies the input color with the specific blue component
Declaration
public void AddBlue(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The blue value |
AddBlueModulation(Double)
Specifies the blue component as expressed by a percentage relative to the input color component
Declaration
public void AddBlueModulation(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The blue modulation value |
AddBlueOffset(Double)
Specifies the blue component as expressed by a percentage offset increase or decrease to the input color component
Declaration
public void AddBlueOffset(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The blue offset value. |
AddComplement()
Specifies that the color rendered should be the complement of its input color with the complement being defined as such. Two colors are called complementary if, when mixed they produce a shade of grey.For instance, the complement of red which is RGB (255, 0, 0) is cyan which is RGB(0, 255, 255)
Declaration
public void AddComplement()AddGamma()
Specifies that the output color rendered by the generating application should be the sRGB gamma shift of the input color.
Declaration
public void AddGamma()AddGray()
Specifies a grayscale of its input color, taking into relative intensities of the red, green, and blue primaries.
Declaration
public void AddGray()AddGreen(Double)
Specifies the input color with the specific green component
Declaration
public void AddGreen(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The green value |
AddGreenModulation(Double)
Specifies the green component as expressed by a percentage relative to the input color component
Declaration
public void AddGreenModulation(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The green modulation value |
AddGreenOffset(Double)
Specifies the green component as expressed by a percentage offset increase or decrease to the input color component
Declaration
public void AddGreenOffset(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The green offset value. |
AddHue(Double)
Specifies the input color with the specified hue, but with its saturation and luminance unchanged
Declaration
public void AddHue(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The hue angle from 0-360 |
AddHueModulation(Double)
Specifies the hue as expressed by a percentage relative to the input color
Declaration
public void AddHueModulation(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The hue modulation in a positive percentage |
AddHueOffset(Double)
Specifies the actual angular value of the shift. The result of the shift shall be between 0 and 360 degrees.Shifts resulting in angular values less than 0 are treated as 0. Shifts resulting in angular values greater than 360 are treated as 360.
Declaration
public void AddHueOffset(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The hue offset value. |
AddInverse()
Specifies the inverse of its input color
Declaration
public void AddInverse()AddInverseGamma()
Specifies that the output color rendered by the generating application should be the inverse sRGB gamma shift of the input color
Declaration
public void AddInverseGamma()AddLuminance(Double)
Specifies the input color with the specified luminance, but with its hue and saturation unchanged
Declaration
public void AddLuminance(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The luminance percentage from 0-100 |
AddLuminanceModulation(Double)
Specifies the luminance as expressed by a percentage relative to the input color
Declaration
public void AddLuminanceModulation(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The luminance modulation in a positive percentage |
AddLuminanceOffset(Double)
Specifies the luminance as expressed by a percentage offset increase or decrease to the input color. Increases never increase the luminance beyond 100%, decreases never decrease the saturation below 0%.
Declaration
public void AddLuminanceOffset(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The luminance offset value |
AddRed(Double)
Specifies the input color with the specific red component
Declaration
public void AddRed(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The red value |
AddRedModulation(Double)
Specifies the red component as expressed by a percentage relative to the input color component
Declaration
public void AddRedModulation(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The red modulation value |
AddRedOffset(Double)
Specifies the red component as expressed by a percentage offset increase or decrease to the input color component
Declaration
public void AddRedOffset(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The red offset value. |
AddSaturation(Double)
Specifies the input color with the specified saturation, but with its hue and luminance unchanged
Declaration
public void AddSaturation(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The saturation percentage from 0-100 |
AddSaturationModulation(Double)
Specifies the saturation as expressed by a percentage relative to the input color
Declaration
public void AddSaturationModulation(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The saturation modulation in a positive percentage |
AddSaturationOffset(Double)
Specifies the saturation as expressed by a percentage offset increase or decrease to the input color. Increases never increase the saturation beyond 100%, decreases never decrease the saturation below 0%.
Declaration
public void AddSaturationOffset(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The saturation offset value |
AddShade(Double)
Specifies a lighter version of its input color
Declaration
public void AddShade(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The tint value in percentage 0-100 |
AddTint(Double)
Specifies a lighter version of its input color
Declaration
public void AddTint(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value | The tint value in percentage 0-100 |
Clear()
Clear all items
Declaration
public void Clear()GetEnumerator()
Gets the enumerator for the collection
Declaration
public IEnumerator<IColorTransformItem> GetEnumerator()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerator<IColorTransformItem> | The enumerator |
Remove(IColorTransformItem)
Removes the specific item
Declaration
public void Remove(IColorTransformItem item)Parameters
| Type | Name | Description |
|---|---|---|
| IColorTransformItem | item | The item to remove |
RemoveAt(Int32)
Remote item at a specific position
Declaration
public void RemoveAt(int index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The postion in the list |
RemoveOfType(eColorTransformType)
Remove all items of a specific type
Declaration
public void RemoveOfType(eColorTransformType type)Parameters
| Type | Name | Description |
|---|---|---|
| eColorTransformType | type | The transformation type |
Explicit Interface Implementations
IEnumerable.GetEnumerator()
Declaration
IEnumerator IEnumerable.GetEnumerator()Returns
| Type | Description |
|---|---|
| System.Collections.IEnumerator |