CogoPointCollection.SetRawDescription(IEnumerable<ObjectId>, IEnumerable<String>) Method

Sets the RawDescription property for multiple CogoPoints with different RawDescription values.

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

Syntax

C#

public ObjectIdCollection SetRawDescription(
	IEnumerable<ObjectId> pointIds,
	IEnumerable<string> rawDescs
)

VB

Public Function SetRawDescription ( 
	pointIds As IEnumerable(Of ObjectId),
	rawDescs As IEnumerable(Of String)
) As ObjectIdCollection

C++

public:
ObjectIdCollection^ SetRawDescription(
	IEnumerable<ObjectId>^ pointIds, 
	IEnumerable<String^>^ rawDescs
)

Parameters

pointIds  IEnumerableObjectId

A sequence of ObjectIds of the points you want to set the RawDescription for.

rawDescs  IEnumerableString

A sequence of new RawDescription values.

Return Value

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

Remarks

If there are fewer raw description strings than points, only the first n points in the list will have their RawDescription property set, where n is the number of strings specified.

Example

C#

 1// _civildoc is the active CivilDocument instance.
 2// 
 3CogoPointCollection cogoPoints = _civildoc.CogoPoints;
 4ObjectId pointId = cogoPoints.Add(new Point3d(100, 100, 50), false);
 5string rawDescription = "Raw Description";
 6
 7// set for single point
 8if (cogoPoints.SetRawDescription(pointId, rawDescription) == ObjectId.Null)
 9    write("SetRawDescription 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, false);
15List<ObjectId> pointIdList = GetListFromCollection(pointIds);
16
17// set multiple points to a single description
18ObjectIdCollection success = cogoPoints.SetRawDescription(pointIdList, rawDescription);
19write(String.Format("SetRawDescription 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(rawDescription + i);
25
26// set multiple points to multiple descriptions
27success = cogoPoints.SetRawDescription(pointIdList, descriptions);
28write(String.Format("SetRawDescription success for {0} of {1} points.\n",
29    success.Count, pointIdList.Count));

VB

 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)
 5Dim rawDescription As String = "Raw Description"
 6
 7' set for single point
 8If cogoPoints.SetRawDescription(pointId, rawDescription) = ObjectId.Null Then
 9    write("SetRawDescription 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, False)
16Dim pointIdList As List(Of ObjectId) = GetListFromCollection(pointIds)
17
18' set multiple points to a single description
19Dim success As ObjectIdCollection = cogoPoints.SetRawDescription(pointIdList, rawDescription)
20write([String].Format("SetRawDescription success for {0} of {1} points." & vbLf, success.Count, pointIdList.Count))
21
22Dim descriptions As New List(Of String)()
23For i As Integer = 0 To pointIdList.Count - 1
24    descriptions.Add(rawDescription & i)
25Next
26
27' set multiple points to multiple descriptions
28success = cogoPoints.SetRawDescription(pointIdList, descriptions)
29write([String].Format("SetRawDescription success for {0} of {1} points." & vbLf, success.Count, pointIdList.Count))

See Also

Reference