Class GradientWrapper
Summary description for GradientWrapper.
Namespace: Syncfusion.XlsIO.Implementation
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class GradientWrapper : CommonWrapper, ICloneParent, IGradient, IOptimizedUpdate
Constructors
GradientWrapper()
Creates new gradient wrapper.
Declaration
public GradientWrapper()
GradientWrapper(ShapeFillImpl)
Creates new gradient wrapper.
Declaration
public GradientWrapper(ShapeFillImpl gradient)
Parameters
Type | Name | Description |
---|---|---|
ShapeFillImpl | gradient | Gradient to wrap. |
Properties
BackColor
Represents background color.
Declaration
public Color BackColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
BackColorIndex
Represents background color index.
Declaration
public ExcelKnownColors BackColorIndex { get; set; }
Property Value
Type |
---|
ExcelKnownColors |
BackColorObject
Represents background color object.
Declaration
public ColorObject BackColorObject { get; }
Property Value
Type |
---|
ColorObject |
ForeColor
Represents foreground color.
Declaration
public Color ForeColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
ForeColorIndex
Represents foreground color index.
Declaration
public ExcelKnownColors ForeColorIndex { get; set; }
Property Value
Type |
---|
ExcelKnownColors |
ForeColorObject
Represents foreground color object.
Declaration
public ColorObject ForeColorObject { get; }
Property Value
Type |
---|
ColorObject |
GradientStyle
Declaration
public ExcelGradientStyle GradientStyle { get; set; }
Property Value
Type |
---|
ExcelGradientStyle |
GradientVariant
Represents gradient shading style.
Declaration
public ExcelGradientVariants GradientVariant { get; set; }
Property Value
Type |
---|
ExcelGradientVariants |
Wrapped
Returns wrapped gradient. Read-only.
Declaration
public ShapeFillImpl Wrapped { get; }
Property Value
Type |
---|
ShapeFillImpl |
Methods
BeginUpdate()
This method should be called before several updates to the object will take place.
Declaration
public override void BeginUpdate()
Overrides
CompareTo(IGradient)
Compares with shape fill impl.
Declaration
public int CompareTo(IGradient gradient)
Parameters
Type | Name | Description |
---|---|---|
IGradient | gradient | Shape fill to compare with. |
Returns
Type | Description |
---|---|
System.Int32 | Zero if shape fills are equal. |
EndUpdate()
This method should be called after several updates to the object took place.
Declaration
public override void EndUpdate()
Overrides
TwoColorGradient()
Sets the specified fill to a two-color gradient.
Declaration
public void TwoColorGradient()
TwoColorGradient(ExcelGradientStyle, ExcelGradientVariants)
Sets the specified fill with style to a two-color gradient.
Declaration
public void TwoColorGradient(ExcelGradientStyle style, ExcelGradientVariants variant)
Parameters
Type | Name | Description |
---|---|---|
ExcelGradientStyle | style | Represents shading shading style. |
ExcelGradientVariants | variant | Represents shading variant. |
Events
AfterChangeEvent
Event raised after wrapped font changed.
Declaration
public event EventHandler AfterChangeEvent
Event Type
Type |
---|
System.EventHandler |