Interface IOfficeShapeGradientStops
Represents a collection of IOfficeShapeGradientStop instances.
Namespace: Syncfusion.Office
Assembly: Syncfusion.Compression.Portable.dll
Syntax
public interface IOfficeShapeGradientStops : IEnumerable<IOfficeShapeGradientStop>, IEnumerableProperties
Count
Gets the number of elements in the gradient stop collection. Read-only.
Declaration
int Count { get; }Property Value
| Type |
|---|
| System.Int32 |
Item[Int32]
Gets an instance of IOfficeShapeGradientStop from the gradient stop collection at the specified index. Read-only.
Declaration
IOfficeShapeGradientStop this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index |
Property Value
Methods
Add()
Adds a gradient stop at the end of the collection.
Declaration
IOfficeShapeGradientStop Add()Returns
| Type | Description |
|---|---|
| IOfficeShapeGradientStop | The IOfficeShapeGradientStop instance added. |
Add(Color, Single)
Adds a gradient stop at the specified position. A minimum of 2 gradient stops must be added when using a gradient type fill.
Declaration
void Add(Color rgb, float position)Parameters
| Type | Name | Description |
|---|---|---|
| Color | rgb | The color of the gradient stop. |
| System.Single | position | The position of the gradient stop within the gradient. |
Add(IOfficeShapeGradientStop)
Adds the specified gradient stop object at the end of the collection. A minimum of 2 gradient stops must be added when using a gradient type fill.
Declaration
int Add(IOfficeShapeGradientStop gradientStop)Parameters
| Type | Name | Description |
|---|---|---|
| IOfficeShapeGradientStop | gradientStop | The gradient stop object to add to the collection. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Returns the index of the added gradient stop. |
Clear()
Removes all the elements from the gradient stop collection.
Declaration
void Clear()IndexOf(IOfficeShapeGradientStop)
Returns the zero-based index of the first occurrence of the IOfficeShapeGradientStop instance within the collection.
Declaration
int IndexOf(IOfficeShapeGradientStop gradientStop)Parameters
| Type | Name | Description |
|---|---|---|
| IOfficeShapeGradientStop | gradientStop | The gradient stop instance to locate in the collection. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The zero-based index of the first occurrence of the gradient stop. |
Insert(Int32, IOfficeShapeGradientStop)
Inserts an IOfficeShapeGradientStop item into the gradient stop collection at the specified index.
Declaration
void Insert(int index, IOfficeShapeGradientStop gradientStop)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The zero-based index at which the gradient stop should be inserted. |
| IOfficeShapeGradientStop | gradientStop | The gradient stop item to insert. |
Remove(IOfficeShapeGradientStop)
Removes the first occurrence of the specified IOfficeShapeGradientStop instance from the gradient stop collection.
Declaration
void Remove(IOfficeShapeGradientStop gradientStop)Parameters
| Type | Name | Description |
|---|---|---|
| IOfficeShapeGradientStop | gradientStop | The gradient stop object to remove from the collection. |
RemoveAt(Int32)
Removes the element at the specified index of the gradient stop collection.
Declaration
void RemoveAt(int index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The zero-based index of the element to remove. |