StructuralConnectionHandlerType.AddElementsToCustomConnection Method

Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 26.3.0.0 (26.3.0.0)

Syntax

C#

[ObsoleteAttribute("This method is deprecated in Revit 2026 and may be removed in a later version of Revit. Prefer updateCustomConnectionType instead.")]
public static void AddElementsToCustomConnection(
	StructuralConnectionHandler structuralConnectionHandler,
	IList<Reference> references
)

Parameters

structuralConnectionHandler  StructuralConnectionHandler

The existing StructuralConnectionHandler having custom StructuralConnectionHandlerType which is about to be modified.

references  IList<Reference>

References to elements or subelements which are to be used to modify custom StructuralConnectionHandlerType by adding their representors.

Exceptions

Remarks

Elements or subelements added to a custom connection are deleted and transformed in subelements of the connection. They could be:

• FamilyInstance (structural beams and columns).
• StructuralConnectionHandler elements associated to the connection.
• Specific steel connection elements (bolts, anchors, plates, etc). These connection elements will be of type element but with categories related to structural connections, for example:
  • OST_StructConnectionWelds
  • OST_StructConnectionHoles
  • OST_StructConnectionModifiers
  • OST_StructConnectionShearStuds
  • OST_StructConnectionBolts
  • OST_StructConnectionAnchors
  • OST_StructConnectionPlates

You cannot add: elements connected by any connection handler, generic connections, holes and modifiers that are not on the connected elements.

Example

C#

   // Select elements to add to connection.
   IList<Reference> refs = Utilities.Functions.SelectConnectionElementsCustom(activeDoc);

   if (refs.Count() <= 0)
   {
      return Result.Failed;
   }

   // Start transaction
   trans.Start();
   // Adding the elements to the custom connection, using Revit's StructuralConnectionHandlerType class
   StructuralConnectionHandlerType.UpdateCustomConnectionType(conn, refs, []);
   // Commit the transaction
   ts = trans.Commit();

   if (ts != TransactionStatus.Committed)
   {
      message = "Failed to commit the current transaction !";
      trans.RollBack();
      return Result.Failed;
   }              
}

See Also

Reference