VS:RemoveGradientSegment

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Removes the specified segment from the specified gradient.

PROCEDURE RemoveGradientSegment(
                 gradient       :HANDLE;
                 segmentIndex   :INTEGER);

def vs.RemoveGradientSegment(gradient, segmentIndex):
    return None

Parameters

gradient		HANDLE		Gradient from which to remove a segment.
segmentIndex		INTEGER		Index of segment to be removed.

Example

VectorScript

RemoveGradientSegment (gradientHandle, 4);
{ removes the segment with index 4 }

Python

Version

Availability: from VectorWorks10.0