CogoPointCollectionSetPointName(IEnumerableObjectId, IEnumerableString) Method

Sets the PointName property for multiple CogoPoints with different values.

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

Syntax

public ObjectIdCollection SetPointName(
	IEnumerable<ObjectId> pointIds,
	IEnumerable<string> values
)

Public Function SetPointName ( 
	pointIds As IEnumerable(Of ObjectId),
	values As IEnumerable(Of String)
) As ObjectIdCollection

public:
ObjectIdCollection^ SetPointName(
	IEnumerable<ObjectId>^ pointIds, 
	IEnumerable<String^>^ values
)

Parameters

pointIds IEnumerableObjectId: A sequence of ObjectIds of the points you want to set the PointName property for.
values IEnumerableString: A sequence of strings to set the corresponding point's PointName property to.

Return Value

ObjectIdCollection
An ObjectIdCollection containing the CogoPoints for which the PointName property has been set successfully.

Remarks

If there are fewer strings than points, only the first n points in the list will have their PointName property set, where n is the number of items in the values list.

Example

C++

Copy

 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));

 1' _civildoc is the active CivilDocument instance.
 2'
 3Dim cogoPoints As CogoPointCollection = _civildoc.CogoPoints
 4Dim pointId As ObjectId = cogoPoints.Add(New Point3d(100, 100, 50), False)
 5
 6' set for single point
 7If cogoPoints.SetPointName(pointId, "Point Name") = ObjectId.Null Then
 8    write("SetPointName failed." & vbLf)
 9End If
10
11Dim points As New Point3dCollection()
12points.Add(New Point3d(50, 50, 25))
13points.Add(New Point3d(200, 200, 15))
14Dim pointIds As ObjectIdCollection = cogoPoints.Add(points, False)
15Dim pointIdList As List(Of ObjectId) = GetListFromCollection(pointIds)
16
17Dim names As New List(Of String)()
18For i As Integer = 0 To pointIdList.Count - 1
19    names.Add("Point Name " & i)
20Next
21
22' set multiple points to multiple descriptions
23Dim success As ObjectIdCollection = cogoPoints.SetPointName(pointIdList, names)
24write([String].Format("SetPointName success for {0} of {1} points", success.Count, pointIdList.Count))

Reference

CogoPointCollection Class

SetPointName Overload

Autodesk.Civil.DatabaseServices Namespace