CogoPointCollection.Add(Point3dCollection, String, Boolean, Boolean, Boolean) Method

Adds new CogoPoints at the given locations with the given description information, optionally using a DescriptionKey.

Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.8.0.1516

Syntax

C#

public ObjectIdCollection Add(
	Point3dCollection locations,
	string desc,
	bool useDescriptionKey,
	bool matchOnParams,
	bool useNextPointNumSetting
)

VB

Public Function Add ( 
	locations As Point3dCollection,
	desc As String,
	useDescriptionKey As Boolean,
	matchOnParams As Boolean,
	useNextPointNumSetting As Boolean
) As ObjectIdCollection

C++

public:
ObjectIdCollection^ Add(
	Point3dCollection^ locations, 
	String^ desc, 
	bool useDescriptionKey, 
	bool matchOnParams, 
	bool useNextPointNumSetting
)

Parameters

locations  Point3dCollection

A collection of 3d points specifying the locations of the new CogoPoints.

desc  String

The description of the new CogoPoints.

useDescriptionKey  Boolean

Specifies whether to use the DescriptionKey.

matchOnParams  Boolean

Specifies whether parameters are used in description key matching to rotate and scale the point symbol.

useNextPointNumSetting  Boolean

 

Return Value

ObjectIdCollection

Remarks

If useDescriptionKey is set to false, the behavior of this method is equal to Add(locations, desc).

Example

C#

 1// _civildoc is the active CivilDocument instance.
 2CogoPointCollection cogoPoints = _civildoc.CogoPoints;
 3Point3dCollection points = getRandomPoints();   // Returns collection of random generated points.
 4bool useDescriptionKey = true;
 5bool matchOnParameters = true;
 6// Parameters in the description key are matched and used.
 7cogoPoints.Add(points, "Sample COGO Point", useDescriptionKey, matchOnParameters, false);
 8
 9// Parameters in the description key are not matched.
10points = getRandomPoints();
11matchOnParameters = false;
12cogoPoints.Add(points, "Other Sample COGO Point", useDescriptionKey, matchOnParameters, false);

VB

 1' _civildoc is the active CivilDocument instance.
 2Dim cogoPoints As CogoPointCollection = _civildoc.CogoPoints
 3Dim points As Point3dCollection = getRandomPoints()
 4' Returns collection of random generated points.
 5Dim useDescriptionKey As Boolean = True
 6Dim matchOnParameters As Boolean = True
 7' Parameters in the description key are matched and used.
 8cogoPoints.Add(points, "Sample COGO Point", useDescriptionKey, matchOnParameters, False)
 9
10' Parameters in the description key are not matched.
11points = getRandomPoints()
12matchOnParameters = False

See Also

Reference