CogoPointCollectionSetPointName(ObjectId, String) Method

Sets the PointName property for a single CogoPoint.

Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.8.0.292
Syntax
public ObjectId SetPointName(
	ObjectId pointId,
	string name
)

Parameters

pointId  ObjectId
The ObjectId of the point you want to set the PointName property for.
name  String
 

Return Value

ObjectId
If the method succeeds, it returns the same ObjectId pointId passed in. If the method fails, it returns ObjectId.Null.
Example
 1// _civildoc is the active CivilDocument instance.
 2// 
 3CogoPointCollection cogoPoints = _civildoc.CogoPoints;
 4ObjectId pointId = cogoPoints.Add(new Point3d(100, 100, 50), false);
 5
 6// set for single point
 7if (cogoPoints.SetPointName(pointId, "Point Name") == ObjectId.Null)
 8    write("SetPointName failed.\n");
 9
10Point3dCollection points = new Point3dCollection();
11points.Add(new Point3d(50, 50, 25));
12points.Add(new Point3d(200, 200, 15));
13ObjectIdCollection pointIds = cogoPoints.Add(points, false);
14List<ObjectId> pointIdList = GetListFromCollection(pointIds);
15
16List<string> names = new List<string>();
17for (int i = 0; i < pointIdList.Count; i++)
18    names.Add("Point Name " + i);
19
20// set multiple points to multiple descriptions
21ObjectIdCollection success = cogoPoints.SetPointName(pointIdList, names);
22write(String.Format("SetPointName success for {0} of {1} points\n",
23  success.Count, pointIdList.Count));
See Also