IColorRamp Interface
Provides the base requirements for color ramp.
public interface IColorRamp
Properties
Base
Gets the base (middle) IColorRampShade in the color ramp.
IColorRampShade Base { get; }
Property Value
- IColorRampShade:
The base (middle) IColorRampShade in the color ramp.
Darkest
Gets the darkest IColorRampShade in the color ramp.
IColorRampShade Darkest { get; }
Property Value
- IColorRampShade:
The darkest IColorRampShade in the color ramp.
FamilyName
Gets a ColorFamilyName value that specifies the color family name.
ColorFamilyName FamilyName { get; }
Property Value
- ColorFamilyName:
A ColorFamilyName value that specifies the color family name.
this[ShadeName]
Returns the IColorRampShade in the color ramp with the specified ShadeName.
IColorRampShade this[ShadeName shadeName] { get; }
Parameter | Type | Description |
---|---|---|
shadeName | ShadeName | The ShadeName that specifies the desired shade. |
Property Value
- IColorRampShade:
The IColorRampShade in the color ramp with the specified ShadeName.
Name
Gets the color ramp name, which is often the same as the ColorFamilyName.
string Name { get; }
Property Value
- string:
The color ramp name, which is often the same as the ColorFamilyName.
Methods
GetShade(int)
Returns the IColorRampShade for the specified shade number.
IColorRampShade GetShade(int shadeNumber)
Parameter | Type | Description |
---|---|---|
shadeNumber | int | The shade number (0..1000). |
Returns
- IColorRampShade:
The IColorRampShade for the specified shade number.