| Product(s): | OpenRoads Designer |
| Version(s): | 10.08.01.33+ |
| Area: | Item Types |
| Original Author: | Bentley Technical Support Group |
Question:
How can I find the proper syntax for Item Types related to Nodes and Conduits?
Answer:
You can find a full list of the MicroStation Syntax here. Here is a list of the most common syntax to use for Item Types on nodes and conduits:
| Category | Property | Expression | MS | ORD |
| Element Properties | Element Description | this.GetElement().ElementDescription | X | X |
| Element Properties | Level Name | this.GetElement().Level | X | X |
| Element Properties | Color | this.GetElement().Color | X | X |
| Element Properties | Line Style | this.GetElement().Style | X | X |
| Element Properties | Custom Line Style Name | this.GetElement().GetDisplayString("Style") | X | X |
| Element Properties | Weight | this.GetElement().Weight | X | X |
| Element Properties | Class | this.GetElement().ElementClass | X | X |
| Element Properties | Number of Elements | this.GetElement().NumElems | X | X |
| Element Properties | Template | this.GetElement().Template | X | X |
| Element Properties | Transparency | this.GetElement().Transparency | X | X |
| Element Properties | Priority | this.GetElement().Priority | X | X |
| Element Properties | Element ID | this.GetElement().ElementID | X | X |
| Element Properties | Area | this.GetElement().Area | X | X |
| Solid | Length of Solid | this.GetElement().Length | X | |
| Solid | Width of Solid | this.GetElement().Width | X | |
| Solid | Height of Solid | this.GetElement().Height | X | |
| Length | Linear Length (CAD Lines) | this.GetElement().TotalLength | X | |
| Mesh | Top Sloped Area | this.GetElement().MeshSurfaceEntity_SlopedArea | X | X |
| Mesh | Planar Area | this.GetElement().MeshSurfaceEntity_PlanarArea | X | X |
| Mesh | Volume | this.GetElement().MeshSurfaceEntity_CivilVolume | X | X |
| Length | 2D Length (Civil Geometry) | this.GetElement().LinearElement_Length | X | |
| Length | 3D Length (Civil Geometry) | this.GetElement().LinearElement_Length3d | 10.10+ | |
| Area | Area | this.GetElement().EnclosedArea | X | |
| Feature | Feature Name | this.GetElement().FeatureName | X | |
| Feature | Feature Definition | this.GetElement().ObjectSettings | X | |
| Feature | Feature Definition Description (Survey Only) | this.GetElement().FeatureDescription | ||
| Feature | Feature Description (Geometry Point Only) | this.GetElement().PointEntity2d_Description | X | |
| Feature | Feature Description (Survey Only) | this.GetElement().Description | ||
| Survey | Name | this.GetElement().Name | X | |
| Survey | Display | this.GetElement().Display | X | |
| Survey | Field Code | this.GetElement().Feature | X | |
| Survey | Zone | this.GetElement().Zone | X | |
| Survey | Description | this.GetElement().Description | X | |
| Survey | Terrain Model Attribute | this.GetElement().DTMAttribute | X | |
| Survey | Length | this.GetElement().Length | X | |
| Survey | Data File Name | this.GetElement().NetworkName | X | |
| Survey | Field Book Name | this.GetElement().DatasetName | X | |
| Survey | Feature Definition | see Feature categroy | X | |
| Survey | Feature Description | see Feature categroy | X | |
| Drainage - Node | Ground Elevation | this.GetElement().Physical_TopElevation | X | |
| Drainage - Node | Rim Elevation | this.GetElement().Physical_RimElevation | X | |
| Drainage - Node | Invert Elevation | this.GetElement().Physical_Elevation | X | |
| Drainage - Node | Use Slope of Surface | this.GetElement().OrientTopToSurface | X | |
| Drainage - Node | Elevation Reference | this.GetElement().ActiveReference | X | |
| Drainage - Node | Station/Offset Reference | this.GetElement().ActiveStationOffsetReference | X | |
| Drainage - Node | Node Name | this.GetElement().Label | X | |
| Drainage - Node | Node ID | this.GetElement().ID | X | |
| Drainage - Node | Node ID | this.GetElement().ElementID | X | |
| Drainage - Node | Diameter | this.GetElement().CircularStructureType_Diameter | X | |
| Drainage - Node | Length | this.GetElement().BoxStructureType_Length | X | |
| Drainage - Node | Width | this.GetElement().BoxStructureType_Width | X | |
| Drainage - Link | Description | this.GetElement().PROP_SU_Description | X | |
| Drainage - Link | Trench | this.GetElement().PROP_SU_CreateTrench | X | |
| Drainage - Link | Single Gradient | this.GetElement().PROP_SU_InterpolateElevations | X | |
| Drainage - Link | Link Name | this.GetElement().Label | X | |
| Drainage - Link | Link ID | this.GetElement().ID | X | |
| Drainage - Link | Conduit Description | this.GetElement().Physical_ConduitShapeLabel | X | |
| Drainage - Link | Size | this.GetElement().DerivedConduitSizeResults_CatalogPipeSize | X | |
| Drainage - Link | Material | this.GetElement().Physical_Material | X | |
| Drainage - Link | Diameter | this.GetElement().ConduitDiameter | X | |
| Drainage - Link | Wall Thickness | this.GetElement().ConduitThickness | X | |
| Drainage - Link | Number of Barrels | this.GetElement().Physical_NumberOfBarrels | X | |
| Drainage - Link | Manning's n | this.GetElement().Physical_ManningsN | X | |
| Drainage - Link | Start Node Name | this.GetElement().PROP_SU_StartNode | X | |
| Drainage - Link | Start Node ID | this.GetElement().HMITopologyStartNodeID | X | |
| Drainage - Link | Start Node Invert | this.GetElement().Physical_UpstreamInvert | X | |
| Drainage - Link | Stop Node Name | this.GetElement().PROP_SU_StopNode | X | |
| Drainage - Link | Stop Node ID | this.GetElement().HMITopologyStopNodeID | X | |
| Drainage - Link | Stop Node Invert | this.GetElement().Physical_DownstreamInvert | X | |
| Drainage - Link | Length | this.GetElement().DerivedLinkResults_UnifiedLength | X | |
| Drainage - Link | Length (Construction) | this.GetElement().ConstructionLength | X | |
| Drainage - Link | Slope | this.GetElement().DerivedLinkResults_Slope | X | |
| Drainage - Link | Flow | this.GetElement().BasicFlowResults_Flow | X | |
| Drainage - Link | Velocity | this.GetElement().BasicVelocityResults_Velocity | X | |
| Drainage - Link | Depth (Normal) | this.GetElement().GVFConduitResults_NormalDepth | X | |
| Drainage - Link | Depth (Critical) | this.GetElement().GVFConduitResults_CriticalDepth | X | |
| Drainage - Link | Area (Full Flow) | this.GetElement().DerivedPhysicalLinkResults_FullFlowArea | X | |
| Drainage - Link | Area (Flow) | this.GetElement().RatConduitResults_FlowArea | X | |
| Math | Addition | 1 + 4 | X | X |
| Math | Multiplication | 2.3 * 3 | X | X |
| Math | Division (duble result) | 12/5 | X | X |
| Math | Division (integer result) | 12\5 | X | X |
| Math | Remainer | 25 mod 3 | X | X |
| Math | Absolute | System.Math.Abs(-45.39) | X | X |
| Math | Round | System.Math.Round(4.53459,2) | X | X |
| Math | Ceiling | system.Math.Ceiling(4.53495) | X | X |
| Math | Maximum | System.Math.Max(1.2, 1.1) | X | X |
| Math | PI | System.Math.PI | X | X |
| Math | Sin | System.Math.Sin(45*System.Math.PI/180) | X | X |
| File/Model | File Name | this.GetFile().FileName | X | X |
| File/Model | Model Name | this.GetModel().Name | X | X |
| File/Model | Model Is 3D | this.GetModel().Is3D | X | X |
| Logical | If-Then | iif(Test_Expression, True_value, False_value) | X | X |
| Lookup | Lookup | Lookup.GetEntry(tabName,keyName,stringValue).returnValue | X | X |
| Format | Station Format | System.String.Format("{0:###+###.##}",this.Station_Double) | X |
If you want to see all properties available for inclusion in item types, then:
- Create a new DGN
- Place the elements you are interested in. Create as few elements as possible – e.g. one node, or two nodes and one link
- Make a note of the names of the elements created
- Use the key-in ecx items dump
- Look in the message center to see the name and location of the file created
- Search the file using the name of the element
- Review the names of the properties – you should see some that look familiar