SetPointName Method (ObjectId, String)

Sets the PointName property for a single CogoPoint.

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

Syntax

C#

public ObjectId SetPointName(
	ObjectId pointId,
	string name
)

Visual Basic

Public Function SetPointName ( _
	pointId As ObjectId, _
	name As String _
) As ObjectId

Visual C++

public:
ObjectId SetPointName(
	ObjectId pointId, 
	String^ name
)

Parameters

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

Return Value

If the method succeeds, it returns the same ObjectId pointId passed in. If the method fails, it returns ObjectId.Null.

Examples

CopyC#
 1// _civildoc is the active CivilDocument instance.
 2// 
 3CogoPointCollection cogoPoints = _civildoc.CogoPoints;
 4ObjectId pointId = cogoPoints.Add(new Point3d(100, 100, 50));
 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);
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));
CopyVB.NET
 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))
 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)
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))

See Also