IPoints

A point is a shape with a dimension of 0 that has a single x,y coordinate value.

	Properties
	Count	Gets the number of points in the geometry.
	Item	Gets the IPoint element in the specified zero-based index.
	Methods
	AddPoint	Adds a point to the geometry.
	DeletePoint	Deletes a point from the geometry.
	InsertPoint	Inserts a point in the selected position on the geometry.
	ToArray	Converts the list of geometry points to an array

Count

Gets the number of points in the geometry.

 

JavaScript
Count

 

C#
int Count { get; }

 

C++
HRESULT Count([out, retval] long* pVal)

Item

Gets the IPoint element in the specified zero-based index. To access a specific element use the following syntax: IPoints(index).

C# exposes this property as an indexer accessed using the following syntax: IPoints[index].

 

JavaScript
Item(        Index)

 

C#
dynamic this[object Index] { get; }

 

C++
HRESULT Item(        [in] VARIANT Index,        [out, retval] VARIANT* pVal)

AddPoint

Adds a point to the geometry after the last point.

 

JavaScript
AddPoint(        X,        Y,        Z)

 

C#
void AddPoint(        double X,        double Y,        double Z)

 

C++
HRESULT AddPoint(        double X,        double Y,        double Z)

Parameters

X

The point’s x-coordinate in the project’s coordinate system units.

Y

The point’s y-coordinate in the project’s coordinate system units.

Z

The point’s z-coordinate in the project’s coordinate system units.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

DeletePoint

Deletes a point from the geometry.

 

JavaScript
DeletePoint(        Index)

 

C#
void DeletePoint(        int Index)

 

C++
HRESULT DeletePoint(        long Index)

Parameters

Index

The zero-based index of the point, which should be deleted. Use Count to determine the number of points.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

InsertPoint

Inserts a point in the specified position on the geometry.

 

JavaScript
InsertPoint(        InsertAfterIndex,        X,        Y,        Z)

 

C#
void InsertPoint(        int InsertAfterIndex,        double X,        double Y,        double Z)

 

C++
HRESULT InsertPoint(        long InsertAfterIndex,        double X,        double Y,        double Z)

 

Parameters

InsertAfterIndex

The zero-based index of the point after which a point should be inserted. Use Count to determine the number of points.

X

The point’s x-coordinate in the project’s coordinate system units.

Y

The point’s y-coordinate in the project’s coordinate system units.

Z

The point’s z-coordinate in the project’s coordinate system units.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

ToArray

Converts the list of geometry points to an array.

 

JavaScript
ToArray()

 

C#
dynamic ToArray()

 

C++
HRESULT ToArray(        VARIANT* var)

 

Return Value

var

A Safe Array that contains triplets of doubles. Each triplet is composed of an x-coordinate, a y-coordinate, and a height.

Note:    In JavaScript, use the VBArray object. See “Using the VBArray Object” for more information.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.