Sets the DescriptionFormat property for multiple CogoPoints with different values.

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

Syntax

C#
public ObjectIdCollection SetDescriptionFormat(
	IEnumerable<ObjectId> pointIds,
	IEnumerable<string> values
)
Visual Basic
Public Function SetDescriptionFormat ( _
	pointIds As IEnumerable(Of ObjectId), _
	values As IEnumerable(Of String) _
) As ObjectIdCollection
Visual C++
public:
ObjectIdCollection^ SetDescriptionFormat(
	IEnumerable<ObjectId>^ pointIds, 
	IEnumerable<String^>^ values
)

Parameters

pointIds
Type: System.Collections.Generic..::..IEnumerable<(Of <(<'ObjectId>)>)>
A sequence of ObjectIds of the points you want to set the DescriptionFormat property for.
values
Type: System.Collections.Generic..::..IEnumerable<(Of <(<'String>)>)>
A sequence of strings to set the corresponding point's DescriptionFormat property to.

Return Value

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

Remarks

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

Examples

CopyC#
 1// _civildoc is the active CivilDocument instance.
 2// 
 3CogoPointCollection cogoPoints = _civildoc.CogoPoints;
 4ObjectId pointId = cogoPoints.Add(new Point3d(100, 100, 50));
 5String descriptionFormat = "$*";
 6
 7// set for single point
 8if (cogoPoints.SetDescriptionFormat(pointId, descriptionFormat) == ObjectId.Null)
 9    write("SetDescriptionFormat failed.\n");
10
11Point3dCollection points = new Point3dCollection();
12points.Add(new Point3d(50, 50, 25));
13points.Add(new Point3d(200, 200, 15));
14ObjectIdCollection pointIds = cogoPoints.Add(points);
15List<ObjectId> pointIdList = GetListFromCollection(pointIds);
16
17// set multiple points to a single description
18ObjectIdCollection success = cogoPoints.SetDescriptionFormat(pointIdList, descriptionFormat);
19write(String.Format("SetDescriptionFormat success for {0} of {1} points\n",
20   success.Count, pointIdList.Count));
21
22List<string> descriptions = new List<string>();
23for (int i = 0; i < pointIdList.Count; i++)
24    descriptions.Add(descriptionFormat + " " + i);
25
26// set multiple points to multiple descriptions
27success = cogoPoints.SetDescriptionFormat(pointIdList, descriptions);
28write(String.Format("SetDescriptionFormat success for {0} of {1} points\n",
29   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))
 5Dim descriptionFormat As [String] = "$*"
 6
 7' set for single point
 8If cogoPoints.SetDescriptionFormat(pointId, descriptionFormat) = ObjectId.Null Then
 9    write("SetDescriptionFormat failed." & vbLf)
10End If
11
12Dim points As New Point3dCollection()
13points.Add(New Point3d(50, 50, 25))
14points.Add(New Point3d(200, 200, 15))
15Dim pointIds As ObjectIdCollection = cogoPoints.Add(points)
16Dim pointIdList As List(Of ObjectId) = GetListFromCollection(pointIds)
17
18' set multiple points to a single description
19Dim success As ObjectIdCollection = cogoPoints.SetDescriptionFormat(pointIdList, descriptionFormat)
20write([String].Format("SetDescriptionFormat success for {0} of {1} points", success.Count, pointIdList.Count))
21
22Dim descriptions As New List(Of String)()
23For i As Integer = 0 To pointIdList.Count - 1
24    descriptions.Add(descriptionFormat & " " & i)
25Next
26
27' set multiple points to multiple descriptions
28success = cogoPoints.SetDescriptionFormat(pointIdList, descriptions)
29write([String].Format("SetDescriptionFormat success for {0} of {1} points", success.Count, pointIdList.Count))

See Also