Sets Elevation for a single CogoPoint.

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

Syntax

C#
public ObjectId SetElevation(
	ObjectId pointId,
	double elevation
)
Visual Basic
Public Function SetElevation ( _
	pointId As ObjectId, _
	elevation As Double _
) As ObjectId
Visual C++
public:
ObjectId SetElevation(
	ObjectId pointId, 
	double elevation
)

Parameters

pointId
Type: ObjectId
The ObjectId of the point you want to set the elevation for.
elevation
Type: System..::..Double
The new elevation value. Specify Double.NaN to unset the elevation.

Return Value

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

Remarks

If you want to set the elevation to the state of "Has not beet set" for the CogoPoint, set the elevation to Double.NaN.

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 value for single point
 7if (cogoPoints.SetElevation(pointId, 125) == ObjectId.Null)
 8    write("SetElevation 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
16// set multiple points to a single value
17ObjectIdCollection success = cogoPoints.SetElevation(pointIdList, 125);
18write(String.Format("SetElevation success for {0} of {1} points\n",
19   success.Count, pointIdList.Count));
20
21List<double> eastings = new List<double>();
22for (int i = 0; i < pointIdList.Count; i++)
23    eastings.Add(i * 10);
24
25// set multiple points to multiple values
26success = cogoPoints.SetElevation(pointIdList, eastings);
27write(String.Format("SetElevation success for {0} of {1} points\n",
28   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 value for single point
 7If cogoPoints.SetElevation(pointId, 125) = ObjectId.Null Then
 8    write("SetElevation 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
17' set multiple points to a single value
18Dim success As ObjectIdCollection = cogoPoints.SetElevation(pointIdList, 125)
19write([String].Format("SetElevation success for {0} of {1} points", success.Count, pointIdList.Count))
20
21Dim eastings As New List(Of Double)()
22For i As Integer = 0 To pointIdList.Count - 1
23    eastings.Add(i * 10)
24Next
25
26' set multiple points to multiple values
27success = cogoPoints.SetElevation(pointIdList, eastings)
28write([String].Format("SetElevation success for {0} of {1} points", success.Count, pointIdList.Count))

See Also