The Structure type exposes the following members.

Methods

  NameDescription
Public methodAddToProfileView
Draws the part into the specified profile view.
(Inherited from Part.)
Public methodAddToSectionView
Draws the part into the specified section view.
(Inherited from Part.)
Public methodApplyRules (Inherited from Part.)
Public methodComputeFingerPrint
Compute FingerPrint of the Entity.
(Inherited from Entity.)
Public methodConnectToPipe
Connect this structure to the specified pipe.
Public methodDisconnect
Disconnect from a pipe.
Public methodGetAvailableStructureLabelIds
Gets an ObjectIdCollection of StructureLabels on the Structure.
Public methodGetConnectedPipeNames
Gets all the connected pipe names.
Public methodGetLabelIds Obsolete.
Gets an ObjectIdCollection of labels on the Structure.
Public methodGetOverriddenRuleIds
Gets the overridden Rule ids which this part contains.
(Inherited from Part.)
Public methodGetProfileViewsDisplayingMe
Gets the object id collection of all the profile views in which this part was drawn.
(Inherited from Part.)
Public methodGetReferenceInfo
For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity.)
Public methodGetSectionViewsDisplayingMe
Gets the object id collection of all the section views in which this part was drawn.
(Inherited from Part.)
Public methodIsConnectedPipeFlowingIn
Determines if the connected pipe is flowing into the structure
Public methodIsConnectedPipeFlowingOut
Determines if the connected pipe is flowing out of the structure
Public methodIsPointInsideStructureRegion
Returns true if the point is within the structure region.
Public methodRemoveFromAllProfileViews
Remove the part from all the profile views in which it is drawn.
(Inherited from Part.)
Public methodRemoveFromAllSectionViews
Removes the part from all the section views in which it is drawn.
(Inherited from Part.)
Public methodRemoveFromProfileView
Remove the part from the specified profile view in which it is drawn.
(Inherited from Part.)
Public methodRemoveFromSectionView
Removes the part from the specified section view in which it is drawn.
(Inherited from Part.)
Public methodResizeByPipeDepths
Resize the structure by pipe depths.
Public methodResizeJunctionStructure
Resize the Junction structure by rim and sump elevations.
Public methodSwapPartFamilyAndSize
Swaps the part family and size.
(Inherited from Part.)

Properties

  NameDescription
Public propertyApplication
Gets the Application. Not currently implemented.
(Inherited from Entity.)
Public propertyAutomaticRimSurfaceAdjustment
Gets or sets whether the rim should be automatically adjusted.
Public propertyBarrelPipeClearance
Gets the clearance of barrel pipe.
Public propertyBoundingShape
Gets the structure bounding shape.
Public propertyConeHeight
Gets the height of the cone shaped section of the structure.
Public propertyConnectedPartCount
Gets the number of parts that connects to the part
(Inherited from Part.)
Public propertyConnectedPipe
Gets the pipe connected to the structure by index.
Public propertyConnectedPipesCount
Gets the count of the pipes connected to the structure.
Public propertyControlSumpBy
Gets or sets how the sump should be adjusted.
Public propertyCover
Gets the model or type of grate used for a structure intended to be used as a catchbasin.
Public propertyDescription
Gets or sets the Entity object's description.
(Inherited from Entity.)
Public propertyDiameterOrWidth
Gets the structure diameter or width.
Public propertyDisplayName
Gets the Entity object's display name.
(Inherited from Entity.)
Public propertyDocument
Gets the Document. Not currently implemented.
(Inherited from Entity.)
Public propertyDomain
Gets the part's domain.
(Inherited from Part.)
Public propertyEasting
Gets or sets the structure’s easting.
Public propertyFingerPrint
Gets or sets FingerPrint of the Entity.
(Inherited from Entity.)
Public propertyFloorThickness
Gets the thickness of the bottom of the structure.
Public propertyFolderId
Gets the folder ObjectId of the Entity Returns ObjectId::Null if the Entity is located in root folder
(Inherited from Entity.)
Public propertyFrame
Gets the model or type of frame used for a structure.
Public propertyFrameDiameter
Gets the diameter of the structure’s frame.
Public propertyFrameHeight
Gets the height of the structure’s frame.
Public propertyGrate
Gets the grate of the pipe.
Public propertyHeadwallBaseThickness
Gets the thickness of the base of the headwall.
Public propertyHeadwallBaseWidth
Gets the width of the base of the headwall.
Public propertyHeight
Gets the structure height.
Public propertyInnerDiameterOrWidth
Gets the structure inner diameter or width.
Public propertyInnerLength
Gets the structure inner length.
Public propertyIsReferencedSourceExisting
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.)
Public propertyIsReferenceObject
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.)
Public propertyIsReferenceStale
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is stale.
(Inherited from Entity.)
Public propertyIsReferenceSubObject
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.)
Public propertyIsReferenceValid
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is valid.
(Inherited from Entity.)
Public propertyIsUsed
Gets whether the style is used by other objects in the current drawing.
(Inherited from Entity.)
Public propertyLength
Gets the structure length.
Public propertyLocation
Gets or sets the location.
Public propertyMaterial
Gets the material defined for this part.
(Inherited from Part.)
Public propertyName
Gets part's name.
(Inherited from Part.)
Public propertyNetworkId
Gets the object id of the network to which this part belongs
(Inherited from Part.)
Public propertyNetworkName
Gets the name of the network to which this part belongs
(Inherited from Part.)
Public propertyNorthing
Gets or sets the structure’s northing.
Public propertyOffset
Gets the structure’s offset.
Public propertyOverrideRuleSet
Gets or sets whether to use overridden rules.
(Inherited from Part.)
Public propertyParamsBool
Gets the boolean parameters collection.
(Inherited from Part.)
Public propertyParamsDouble
Gets the double parameters collection.
(Inherited from Part.)
Public propertyParamsLong
Gets the long parameters collection.
(Inherited from Part.)
Public propertyParamsString
Gets the string parameters collection.
(Inherited from Part.)
Public propertyPartData
Gets or sets the part data record.
(Inherited from Part.)
Public propertyPartDefId
Gets the object id of PartDef.
(Inherited from Part.)
Public propertyPartDescription
Gets the part’s description.
(Inherited from Part.)
Public propertyPartFamilyId
Gets the part family Id
(Inherited from Part.)
Public propertyPartFamilyName
Gets the part family name
(Inherited from Part.)
Public propertyPartSizeName
Gets the part size name.
(Inherited from Part.)
Public propertyPartSubType
Gets the part’s subtype.
(Inherited from Part.)
Public propertyPartType
Gets the type of the network park.
(Inherited from Part.)
Public propertyPipeCenterDepth
Gets the center depth of the pipe.
Public propertyPipeInnerDiameterOrWidth
Gets the inner diameter or inner width of the pipe.
Public propertyPipeInvertDepth
Gets the invert depth.
Public propertyPipeLowestBottomDepth
Gets the lowest bottom depth of a pipe.
Public propertyPipeOuterBottomDepth
Gets the outer bottom pipe depth.
Public propertyPipeOuterTopDepth
Gets the outer top pipe depth.
Public propertyPipeUpperTopDepth
Gets the upper top depth of a pipe.
Public propertyPipeWallThickness
Gets the pipe wall thickness.
Public propertyPosition
Gets or sets the position of the network part.
(Inherited from Part.)
Public propertyProfileViewPartId
Gets the object id of the part's counterpart in profile views.
(Inherited from Part.)
Public propertyRefAlignmentId
Gets or sets the object id of the alignment which this part references.
(Inherited from Part.)
Public propertyRefAlignmentName
Gets the name of the alignment which this part references
(Inherited from Part.)
Public propertyRefSurfaceId
Gets or sets the object id of the surface that this part references.
(Inherited from Part.)
Public propertyRefSurfaceName
Gets the name of the surface which this part references.
(Inherited from Part.)
Public propertyRimElevation
Gets or sets the rim elevation.
Public propertyRimToSumpHeight
Gets or sets the distance between the sump to the structure’s rim.
Public propertyRotation
Gets or sets the structure rotation.
Public propertyRuleSetStyleId
Gets or sets the object id of RuleSetStyle.
(Inherited from Part.)
Public propertyRuleSetStyleName
Gets or sets RuleSetStyle by name.
(Inherited from Part.)
Public propertySectionViewPartId
Gets the object id of the part's counterpart in section views.
(Inherited from Part.)
Public propertyShowToolTip
Gets or sets whether to show tooltips for the Entity.
(Inherited from Entity.)
Public propertySolid3dBody
Gets the 3d solid body of the part.
(Inherited from Part.)
Public propertyStation
Gets the structure’s station.
Public propertyStyleId
Sets the styleId of Structure.
(Overrides Entity..::..StyleId.)
Public propertyStyleName
Gets or sets the Entity object's style name.
(Inherited from Entity.)
Public propertySumpDepth
Gets or sets the sump depth.
Public propertySumpElevation
Gets or sets the sump elevation.
Public propertySurfaceAdjustmentValue
Gets or sets the surface adjustment value
Public propertySurfaceElevationAtInsertionPoint
Gets the inner diameter or inner width of the pipe.
Public propertySurfaceId Obsolete.
Gets or sets the object id of the surface that this part references.
(Inherited from Part.)
Public propertyVerticalPipeClearance
Gets the clearance required from the top outside of the highest pipe connected to the structure, to the rim.
Public propertyWallThickness
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.)

See Also