Interface IOfficeInkTraces
Represents a collection of ink traces used in Office Ink, allowing for creation, access, and management of individual ink strokes.
Namespace: Syncfusion.Office
Assembly: Syncfusion.Compression.NET.dll
Syntax
public interface IOfficeInkTracesProperties
Count
Gets the number of ink traces in the collection.
Declaration
int Count { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The total count of IOfficeInkTrace items. |
Item[Int32]
Gets the ink trace at the specified index.
Declaration
IOfficeInkTrace this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The zero-based index of the trace to retrieve. |
Property Value
| Type | Description |
|---|---|
| IOfficeInkTrace | The IOfficeInkTrace at the specified index. |
Methods
Add(PointF[])
Adds a new ink trace to the collection using the specified sequence of points.
Declaration
IOfficeInkTrace Add(PointF[] tracePoints)Parameters
| Type | Name | Description |
|---|---|---|
| PointF[] | tracePoints | An array of PointF representing the path of the ink stroke. |
Returns
| Type | Description |
|---|---|
| IOfficeInkTrace | The newly created IOfficeInkTrace instance added to the collection. |
Clear()
Removes all ink traces from the collection.
Declaration
void Clear()IndexOf(IOfficeInkTrace)
Returns the index of the specified ink trace within the collection.
Declaration
int IndexOf(IOfficeInkTrace inkTrace)Parameters
| Type | Name | Description |
|---|---|---|
| IOfficeInkTrace | inkTrace | The IOfficeInkTrace to locate. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The zero-based index of the trace if found; otherwise, -1. |
Remove(IOfficeInkTrace)
Removes the specified ink trace from the collection.
Declaration
bool Remove(IOfficeInkTrace inkTrace)Parameters
| Type | Name | Description |
|---|---|---|
| IOfficeInkTrace | inkTrace | The IOfficeInkTrace to remove. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
|
RemoveAt(Int32)
Removes the ink trace at the specified index.
Declaration
void RemoveAt(int index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | The zero-based index of the trace to remove. |