The Structure type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| AddToProfileView |
Draws the part into the specified profile view.
(Inherited from Part.) | |
| AddToSectionView |
Draws the part into the specified section view.
(Inherited from Part.) | |
| ApplyRules | (Inherited from Part.) | |
| ComputeFingerPrint |
Compute FingerPrint of the Entity.
(Inherited from Entity.) | |
| ConnectToPipe |
Connect this structure to the specified pipe.
| |
| Disconnect |
Disconnect from a pipe.
| |
| GetAvailableStructureLabelIds |
Gets an ObjectIdCollection of StructureLabels on the Structure.
| |
| GetConnectedPipeNames |
Gets all the connected pipe names.
| |
| GetLabelIds | Obsolete.
Gets an ObjectIdCollection of labels on the Structure.
| |
| GetOverriddenRuleIds |
Gets the overridden Rule ids which this part contains.
(Inherited from Part.) | |
| GetProfileViewsDisplayingMe |
Gets the object id collection of all the profile views in which this part was drawn.
(Inherited from Part.) | |
| GetReferenceInfo |
For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity.) | |
| GetSectionViewsDisplayingMe |
Gets the object id collection of all the section views in which this part was drawn.
(Inherited from Part.) | |
| IsConnectedPipeFlowingIn |
Determines if the connected pipe is flowing into the structure
| |
| IsConnectedPipeFlowingOut |
Determines if the connected pipe is flowing out of the structure
| |
| IsPointInsideStructureRegion |
Returns true if the point is within the structure region.
| |
| RemoveFromAllProfileViews |
Remove the part from all the profile views in which it is drawn.
(Inherited from Part.) | |
| RemoveFromAllSectionViews |
Removes the part from all the section views in which it is drawn.
(Inherited from Part.) | |
| RemoveFromProfileView |
Remove the part from the specified profile view in which it is drawn.
(Inherited from Part.) | |
| RemoveFromSectionView |
Removes the part from the specified section view in which it is drawn.
(Inherited from Part.) | |
| ResizeByPipeDepths |
Resize the structure by pipe depths.
| |
| ResizeJunctionStructure |
Resize the Junction structure by rim and sump elevations.
| |
| SwapPartFamilyAndSize |
Swaps the part family and size.
(Inherited from Part.) |
Properties
| Name | Description | |
|---|---|---|
| Application |
Gets the Application. Not currently implemented.
(Inherited from Entity.) | |
| AutomaticRimSurfaceAdjustment |
Gets or sets whether the rim should be automatically adjusted.
| |
| BarrelPipeClearance |
Gets the clearance of barrel pipe.
| |
| BoundingShape |
Gets the structure bounding shape.
| |
| ConeHeight |
Gets the height of the cone shaped section of the structure.
| |
| ConnectedPartCount |
Gets the number of parts that connects to the part
(Inherited from Part.) | |
| ConnectedPipe |
Gets the pipe connected to the structure by index.
| |
| ConnectedPipesCount |
Gets the count of the pipes connected to the structure.
| |
| ControlSumpBy |
Gets or sets how the sump should be adjusted.
| |
| Cover |
Gets the model or type of grate used for a structure intended to be used as a catchbasin.
| |
| Description |
Gets or sets the Entity object's description.
(Inherited from Entity.) | |
| DiameterOrWidth |
Gets the structure diameter or width.
| |
| DisplayName |
Gets the Entity object's display name.
(Inherited from Entity.) | |
| Document |
Gets the Document. Not currently implemented.
(Inherited from Entity.) | |
| Domain |
Gets the part's domain.
(Inherited from Part.) | |
| Easting |
Gets or sets the structure’s easting.
| |
| FingerPrint |
Gets or sets FingerPrint of the Entity.
(Inherited from Entity.) | |
| FloorThickness |
Gets the thickness of the bottom of the structure.
| |
| FolderId |
Gets the folder ObjectId of the Entity
Returns ObjectId::Null if the Entity is located in root folder
(Inherited from Entity.) | |
| Frame |
Gets the model or type of frame used for a structure.
| |
| FrameDiameter |
Gets the diameter of the structure’s frame.
| |
| FrameHeight |
Gets the height of the structure’s frame.
| |
| Grate |
Gets the grate of the pipe.
| |
| HeadwallBaseThickness |
Gets the thickness of the base of the headwall.
| |
| HeadwallBaseWidth |
Gets the width of the base of the headwall.
| |
| Height |
Gets the structure height.
| |
| InnerDiameterOrWidth |
Gets the structure inner diameter or width.
| |
| InnerLength |
Gets the structure inner length.
| |
| IsReferencedSourceExisting |
For reference object (IsReferenceObject == true), it will try to get its source entity while opening a drawing.
This indicates whether the reference object has source entity.
(Inherited from Entity.) | |
| IsReferenceObject |
Gets whether the Entity is a reference object. A reference object is
located in another drawing, and linked using a data shortcut or Vault.
If the entity is native to the current drawing this property returns false;
if it is being referenced via data shortcuts or AutoCAD Vault it returns true.
(Inherited from Entity.) | |
| IsReferenceStale |
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is stale.
(Inherited from Entity.) | |
| IsReferenceSubObject |
For reference objects (IsReferenceObject == true), gets whether the Entity is a reference subobject.
For example, when iterating through the structure of a pipe network referenced from another drawing,
this property is true for each entity.
(Inherited from Entity.) | |
| IsReferenceValid |
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is valid.
(Inherited from Entity.) | |
| IsUsed |
Gets whether the style is used by other objects in the current drawing.
(Inherited from Entity.) | |
| Length |
Gets the structure length.
| |
| Location |
Gets or sets the location.
| |
| Material |
Gets the material defined for this part.
(Inherited from Part.) | |
| Name |
Gets part's name.
(Inherited from Part.) | |
| NetworkId |
Gets the object id of the network to which this part belongs
(Inherited from Part.) | |
| NetworkName |
Gets the name of the network to which this part belongs
(Inherited from Part.) | |
| Northing |
Gets or sets the structure’s northing.
| |
| Offset |
Gets the structure’s offset.
| |
| OverrideRuleSet |
Gets or sets whether to use overridden rules.
(Inherited from Part.) | |
| ParamsBool | Gets the boolean parameters collection. (Inherited from Part.) | |
| ParamsDouble | Gets the double parameters collection. (Inherited from Part.) | |
| ParamsLong | Gets the long parameters collection. (Inherited from Part.) | |
| ParamsString | Gets the string parameters collection. (Inherited from Part.) | |
| PartData |
Gets or sets the part data record.
(Inherited from Part.) | |
| PartDefId |
Gets the object id of PartDef.
(Inherited from Part.) | |
| PartDescription |
Gets the part’s description.
(Inherited from Part.) | |
| PartFamilyId |
Gets the part family Id
(Inherited from Part.) | |
| PartFamilyName |
Gets the part family name
(Inherited from Part.) | |
| PartSizeName |
Gets the part size name.
(Inherited from Part.) | |
| PartSubType |
Gets the part’s subtype.
(Inherited from Part.) | |
| PartType | Gets the type of the network park. (Inherited from Part.) | |
| PipeCenterDepth |
Gets the center depth of the pipe.
| |
| PipeInnerDiameterOrWidth |
Gets the inner diameter or inner width of the pipe.
| |
| PipeInvertDepth |
Gets the invert depth.
| |
| PipeLowestBottomDepth |
Gets the lowest bottom depth of a pipe.
| |
| PipeOuterBottomDepth |
Gets the outer bottom pipe depth.
| |
| PipeOuterTopDepth |
Gets the outer top pipe depth.
| |
| PipeUpperTopDepth |
Gets the upper top depth of a pipe.
| |
| PipeWallThickness |
Gets the pipe wall thickness.
| |
| Position |
Gets or sets the position of the network part.
(Inherited from Part.) | |
| ProfileViewPartId |
Gets the object id of the part's counterpart in profile views.
(Inherited from Part.) | |
| RefAlignmentId |
Gets or sets the object id of the alignment which this part references.
(Inherited from Part.) | |
| RefAlignmentName |
Gets the name of the alignment which this part references
(Inherited from Part.) | |
| RefSurfaceId |
Gets or sets the object id of the surface that this part references.
(Inherited from Part.) | |
| RefSurfaceName |
Gets the name of the surface which this part references.
(Inherited from Part.) | |
| RimElevation |
Gets or sets the rim elevation.
| |
| RimToSumpHeight |
Gets or sets the distance between the sump to the structure’s rim.
| |
| Rotation |
Gets or sets the structure rotation.
| |
| RuleSetStyleId |
Gets or sets the object id of RuleSetStyle.
(Inherited from Part.) | |
| RuleSetStyleName |
Gets or sets RuleSetStyle by name.
(Inherited from Part.) | |
| SectionViewPartId |
Gets the object id of the part's counterpart in section views.
(Inherited from Part.) | |
| ShowToolTip |
Gets or sets whether to show tooltips for the Entity.
(Inherited from Entity.) | |
| Solid3dBody |
Gets the 3d solid body of the part.
(Inherited from Part.) | |
| Station |
Gets the structure’s station.
| |
| StyleId |
Sets the styleId of Structure.
(Overrides Entity..::..StyleId.) | |
| StyleName |
Gets or sets the Entity object's style name.
(Inherited from Entity.) | |
| SumpDepth |
Gets or sets the sump depth.
| |
| SumpElevation |
Gets or sets the sump elevation.
| |
| SurfaceAdjustmentValue |
Gets or sets the surface adjustment value
| |
| SurfaceElevationAtInsertionPoint |
Gets the inner diameter or inner width of the pipe.
| |
| SurfaceId | Obsolete.
Gets or sets the object id of the surface that this part references.
(Inherited from Part.) | |
| VerticalPipeClearance |
Gets the clearance required from the top outside of the highest pipe connected to the structure, to the rim.
| |
| WallThickness |
Gets the wall thickness for this structure, measured from the inside edge of the structure to the outside edge of the structure.
(Inherited from Part.) |