Share via

Stroke.SetPoints Method

  • Article

Stroke.SetPoints Method

Sets an array of Point Leave Site structures at the specified indices in a Stroke object.

Definition

Visual Basic .NET Public Function SetPoints( _
ByVal index As Integer, _
ByVal points() As Point _
) As Integer
C# public int SetPoints(
int index,
Point[] points
);
Managed C++ public: int* SetPoints(
int *index,
Point *points __gc[]
);

Parameters

index System.Int32. The zero-based index of the first point in the Stroke object to be modified.
points System.Drawing.Point[]. The array of new Point Leave Site values to replace the points in the Stroke object beginning at index.

Return Value

System.Int32. Returns the actual number of points set.

Remarks

This method does not change the number of points in the Stroke object. To change the number of points in the Stroke object, a new Stroke object must be created, or the Stroke object must be split.

The length of the points array determines the count of points to be modified in the Stroke object.

This method does not provide for truncating the Stroke object. If the points array contains fewer points than the Stroke object, the remainder of the points in the Stroke object are not modified.

This method does not provide for extending the Stroke object. If the points array contains more points than the Stroke object, the extra points are not used.

Examples

See Also