Structural |
An object of Structural Connection Handler.
Inheritance HierarchyNamespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
SyntaxThe StructuralConnectionHandler type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ApprovalTypeId | Retrieves or changes approval type of the Structural Connection Handler. |
| AssemblyInstanceId |
The id of the assembly instance to which the element belongs.
(Inherited from Element) |
 | BoundingBox | Retrieves a box that circumscribes all geometry of the element. (Inherited from Element) |
| Category | Retrieves a Category object that represents the category or sub category in which the
element resides. (Inherited from Element) |
| CodeCheckingStatus | Code checking status of the structural connection. |
| CreatedPhaseId |
Id of a Phase at which the Element was created.
(Inherited from Element) |
| DemolishedPhaseId |
Id of a Phase at which the Element was demolished.
(Inherited from Element) |
| DesignOption | Returns the design option to which the element belongs. (Inherited from Element) |
| Document | Returns the Document in which the Element resides. (Inherited from Element) |
| Geometry | Retrieves the geometric representation of the element. (Inherited from Element) |
| GroupId |
The id of the group to which an element belongs.
(Inherited from Element) |
| Id |
A unique identifier for an Element in an Autodesk Revit project.
(Inherited from Element) |
| IsModifiable |
Identifies if the element is modifiable.
(Inherited from Element) |
| IsTransient |
Indicates whether an element is transient or permanent.
(Inherited from Element) |
| IsValidObject |
Specifies whether the .NET object represents a valid Revit entity.
(Inherited from Element) |
| LevelId |
The id of the level associated with the element.
(Inherited from Element) |
| Location | This property is used to find the physical location of an element within a project. (Inherited from Element) |
| Name | A human readable name for the Element. (Inherited from Element) |
| OverrideTypeParams | Allow or disallow connection's type parameters to be overridden. |
| OwnerViewId |
The id of the view that owns the element.
(Inherited from Element) |
| ParameterBuiltInParameter | Retrieves a parameter from the element given a parameter id. (Inherited from Element) |
| ParameterDefinition | Retrieves a parameter from the element based on its definition. (Inherited from Element) |
| ParameterGuid | Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element) |
| Parameters | Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element) |
| ParametersMap | Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element) |
| Pinned |
Identifies if the element has been pinned to prevent changes.
(Inherited from Element) |
| SingleElementEndIndex | Element end index for single element connections (0: start, 1: end). |
| UniqueId |
A stable unique identifier for an element within the document.
(Inherited from Element) |
| VersionGuid |
Get the element version Guid.
(Inherited from Element) |
| ViewSpecific |
Identifies if the element is owned by a view.
(Inherited from Element) |
| WorksetId |
Get Id of the Workset which owns the element.
(Inherited from Element) |
Methods| Name | Description | |
|---|---|---|
 | AddElementIds | Adds element ids to the connection. All element ids in an array should be of applicable category. |
| AddReferences | Adds references to the connection. All references should be of applicable category. |
| ArePhasesModifiable |
Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element) |
| CanBeHidden | Indicates if the element can be hidden in the view. (Inherited from Element) |
| CanBeLocked |
Identifies if the element can be locked.
(Inherited from Element) |
| CanDeleteSubelement |
Checks if given subelement can be removed from the element.
(Inherited from Element) |
| CanHaveTypeAssigned |
Identifies if the element can have a type assigned.
(Inherited from Element) |
| ChangeTypeId(ElementId) |
Changes the type of the element.
(Inherited from Element) |
 | Create(Document, IListElementId, ElementId) | Creates a new instance of a Structural Connection Handler, which defines the connection between given elements. |
| Create(Document, IListElementId, String) | Creates custom StructuralConnectionHandlerType and StructuralConnectionHandler. |
| Create(Document, IListElementId, ElementId, IListConnectionInputPoint) | Creates a new instance of a Structural Connection Handler, which is defined by the elements to connect and the additional points. |
| CreateGenericConnection | Creates a new instance of a Structural Connection Handler with a generic type, which defines the connection between given elements. |
| DeleteEntity |
Deletes the existing entity created by %schema% in the element
(Inherited from Element) |
| DeleteSubelement |
Removes a subelement from the element.
(Inherited from Element) |
| DeleteSubelements |
Removes the subelements from the element.
(Inherited from Element) |
| Dispose | (Inherited from Element) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| EvaluateAllParameterValues |
Evaluates all the parameters' values of the element.
(Inherited from Element) |
| EvaluateParameterValues |
Evaluate the parameters' values of the element on the given parameter ID set.
(Inherited from Element) |
| GetConnectedElementIds | Retrieves list of element ids of connected elements. |
| GetDependentElements |
Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element) |
| GetEntity |
Returns the existing entity corresponding to the Schema if it has been saved in the
Element, or an invalid entity otherwise.
(Inherited from Element) |
| GetEntitySchemaGuids |
Returns the Schema guids of any Entities stored in this element.
(Inherited from Element) |
| GetExternalFileReference |
Gets information pertaining to the external file referenced
by the element.
(Inherited from Element) |
| GetExternalResourceReference |
Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element) |
| GetExternalResourceReferenceExpanded |
Gets the collection of ExternalResourceReference associated with a specified external resource type.
(Inherited from Element) |
| GetExternalResourceReferences |
Gets the map of the external resource references referenced
by the element.
(Inherited from Element) |
| GetExternalResourceReferencesExpanded |
Gets the expanded map of the external resource references referenced
by the element.
(Inherited from Element) |
| GetGeneratingElementIds |
Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element) |
| GetGeometryObjectFromReference |
Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetInputPoint | Returns point with specified id. Returns null if specified point does not exist |
| GetInputPoints | Returns a list of additional points defining certain connections. |
| GetInputReferences | Gets references of input elements. |
| GetMaterialArea |
Gets the area of the material with the given id.
(Inherited from Element) |
| GetMaterialIds |
Gets the element ids of all materials present in the element.
(Inherited from Element) |
| GetMaterialVolume |
Gets the volume of the material with the given id.
(Inherited from Element) |
| GetMonitoredLinkElementIds |
Provides the link instance IDs when the element is monitoring.
(Inherited from Element) |
| GetMonitoredLocalElementIds |
Provides the local element IDs when the element is monitoring.
(Inherited from Element) |
| GetOrderedParameters |
Gets the parameters associated to the element in order.
(Inherited from Element) |
| GetOrigin | Retrieves origin point of Structural Connection Handler element. |
| GetParameter | Retrieves a parameter from the element given identifier. (Inherited from Element) |
| GetParameterFormatOptions |
Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element) |
| GetParameters | Retrieves the parameters from the element via the given name. (Inherited from Element) |
| GetPhaseStatus |
Gets the status of a given element in the input phase
(Inherited from Element) |
| GetSubelements |
Returns the collection of element subelements.
(Inherited from Element) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetTypeId |
Returns the identifier of this element's type.
(Inherited from Element) |
| GetValidTypes |
Obtains a set of types that are valid for this element.
(Inherited from Element) |
| HasPhases |
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element) |
| IsCreatedPhaseOrderValid |
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element) |
| IsCustom | Checks if Structural Connection Handler has the custom connection style. |
| IsDemolishedPhaseOrderValid |
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element) |
| IsDetailed | Checks if Structural Connection Handler has the detailed connection style. |
| IsExternalFileReference |
Determines whether this Element represents an external
file.
(Inherited from Element) |
| IsHidden | Identifies if the element has been permanently hidden in the view. (Inherited from Element) |
| IsMonitoringLinkElement |
Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element) |
| IsMonitoringLocalElement |
Indicate whether an element is monitoring other local elements.
(Inherited from Element) |
| IsPhaseCreatedValid |
Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element) |
| IsPhaseDemolishedValid |
Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element) |
| IsValidType(ElementId) |
Checks if given type is valid for this element.
(Inherited from Element) |
| LookupParameter | Attempts to find a parameter on the element which has the given name. (Inherited from Element) |
| RefersToExternalResourceReference |
Determines whether this Element uses external resources associated with
a specified external resource type.
(Inherited from Element) |
| RefersToExternalResourceReferences |
Determines whether this Element uses external resources.
(Inherited from Element) |
| RemoveElementIds | Removes element ids from the connection. All element ids in an array should belong to the connection. |
| RemoveReferences | Removes references from the connection. All references in an array should belong to the connection. |
| SetDefaultElementOrder | Sorts the connected elements connection according to structural categories, element materials and geometries. The steel element is set rather than an element of other material. The priorities of the elements are set according structural categories in following order: columns, framings, walls, foundations, floors. In case of several Structural Framing elements order is determined by cutting - the cutting element is set as the primary one rather than element being cut. |
| SetEntity |
Stores the entity in the element. If an Entity described by the same Schema already
exists, it is overwritten.
(Inherited from Element) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
See Also