CogoPointCollectionSetIsLocked(ObjectId, Boolean) Method

Sets the IsLocked property for a single CogoPoint.

Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.8.0.292
Syntax
public ObjectId SetIsLocked(
	ObjectId pointId,
	bool isLocked
)

Parameters

pointId  ObjectId
The ObjectId of the point you want to set the IsLocked property for.
isLocked  Boolean
The new isLocked value.

Return Value

ObjectId
If the method succeeds, it returns the same ObjectId pointId passed in. If the method fails, it returns ObjectId.Null.
Example
 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 value for single point
 7if (cogoPoints.SetIsLocked(pointId, true) == ObjectId.Null)
 8    write("SetElevationByOffset 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
16// set multiple points to a single value
17ObjectIdCollection success = cogoPoints.SetIsLocked(pointIdList, true);
18write(String.Format("SetIsLocked success for {0} of {1} points\n",
19  success.Count, pointIdList.Count));
20
21List<bool> locked = new List<bool>();
22for (int i = 0; i < pointIdList.Count; i++)
23    locked.Add(i % 2 == 1);
24
25// set multiple points to multiple values
26success = cogoPoints.SetIsLocked(pointIdList, locked);
27write(String.Format("SetIsLocked success for {0} of {1} points\n",
28  success.Count, pointIdList.Count));
See Also