CogoPointFullDescription Property

Gets an expanded description determined by a description key match.

Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.8.0.292
Syntax
Copy
public string FullDescription { get; }

Property Value

String
Remarks
If there is no description key match, the full description is the same as the raw description. You cannot edit this field, it can be updated only through description key matching.
Example
Copy
 1// _civildoc is the active CivilDocument instance.
 2//                
 3foreach (ObjectId pointId in _civildoc.CogoPoints)
 4{
 5    CogoPoint cogoPoint = pointId.GetObject(OpenMode.ForRead) as CogoPoint;
 6
 7    _editor.WriteMessage("\nCOGO Point: {0}, {1}", cogoPoint.PointNumber, cogoPoint.PointName);
 8    _editor.WriteMessage("\n- Project status:");
 9
10    // Reading ProjectVersion throws an exception if the point is not a project point
11    // 
12    if (cogoPoint.IsProjectPoint)
13    {
14        _editor.WriteMessage("\n-- IsProjectPoint: {0}", cogoPoint.IsProjectPoint);
15        _editor.WriteMessage("\n-- IsCheckedOut: {0}", cogoPoint.IsCheckedOut);
16        _editor.WriteMessage("\n-- ProjectVersion: {0}", cogoPoint.ProjectVersion);
17    }
18    else
19    {
20        _editor.WriteMessage("\n-- COGO Point is not a project point.");
21    }
22
23    // Point Group override properties.
24    // 
25    _editor.WriteMessage("\n- Point Group Overrides:");
26    if (cogoPoint.PrimaryPointGroupId != ObjectId.Null)
27    {
28        PointGroup pointGroup = cogoPoint.PrimaryPointGroupId.GetObject(OpenMode.ForRead) as PointGroup;
29        _editor.WriteMessage("\n-- Point Group Name: {0}", pointGroup.Name);
30        _editor.WriteMessage("\n-- ElevationOverride: {0}", cogoPoint.ElevationOverride);
31        _editor.WriteMessage("\n-- FullDescriptionOverride: {0}", cogoPoint.FullDescriptionOverride);
32        _editor.WriteMessage("\n-- RawDescriptionOverride: {0}", cogoPoint.RawDescriptionOverride);
33        if (cogoPoint.LabelStyleIdOverride != ObjectId.Null)
34        {
35            LabelStyle labelStyle = cogoPoint.LabelStyleIdOverride.GetObject(OpenMode.ForRead) as LabelStyle;
36            _editor.WriteMessage("\n-- Label Style Override Name: {0}", labelStyle.Name);
37        }
38        if (cogoPoint.StyleIdOverride != ObjectId.Null)
39        {
40            PointStyle pointStyle = cogoPoint.StyleIdOverride.GetObject(OpenMode.ForRead) as PointStyle;
41            _editor.WriteMessage("\n-- Style Override Name: {0}", pointStyle.Name);
42        }
43    }
44    else
45    {
46        _editor.WriteMessage("\n-- COGO Point not associated with a Point Group.");
47    }
48
49
50    // Point state properties
51    // 
52    _editor.WriteMessage("\n- Point state:");
53    _editor.WriteMessage("\n-- IsLabelDragged: {0}", cogoPoint.IsLabelDragged);
54    _editor.WriteMessage("\n-- IsMovable: {0}", cogoPoint.IsMovable);
55    _editor.WriteMessage("\n-- IsSurveyPoint: {0}", cogoPoint.IsSurveyPoint);
56
57    // Transform settings properties. Trying to read these properties throws an
58    // exception if  SettingsDrawing.ApplyTransformSettings is false.
59    // 
60    if (_civildoc.Settings.DrawingSettings.ApplyTransformSettings)
61    {
62        _editor.WriteMessage("\n- Transform Properties:");
63        _editor.WriteMessage("\n-- Convergence: {0}", cogoPoint.Convergence);
64        _editor.WriteMessage("\n-- Scale: {0}", cogoPoint.Scale);
65    }
66
67    // Other read-only properties
68    // 
69    _editor.WriteMessage("\n- Other read-only properties:");
70    _editor.WriteMessage("\n-- FullDescription: {0}", cogoPoint.FullDescription);
71    _editor.WriteMessage("\n-- Location: {0}", cogoPoint.Location);
72}
See Also