Namespace: Autodesk.Revit.Creation Class: Document

Document.NewLineBoundaryConditions(Element, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double, TranslationRotationValue, Double)

Method

Description:
Creates a new Line BoundaryConditions element on a host element.

Remarks:
This method will only function with the Autodesk Revit Structure application.

Syntax

public BoundaryConditions NewLineBoundaryConditions(
	Element hostElement,
	TranslationRotationValue X_Translation,
	double X_TranslationSpringModulus,
	TranslationRotationValue Y_Translation,
	double Y_TranslationSpringModulus,
	TranslationRotationValue Z_Translation,
	double Z_TranslationSpringModulus,
	TranslationRotationValue X_Rotation,
	double X_RotationSpringModulus
)

Public Function NewLineBoundaryConditions ( 
	hostElement As Element,
	X_Translation As TranslationRotationValue,
	X_TranslationSpringModulus As Double,
	Y_Translation As TranslationRotationValue,
	Y_TranslationSpringModulus As Double,
	Z_Translation As TranslationRotationValue,
	Z_TranslationSpringModulus As Double,
	X_Rotation As TranslationRotationValue,
	X_RotationSpringModulus As Double
) As BoundaryConditions

public:
BoundaryConditions^ NewLineBoundaryConditions(
	Element^ hostElement, 
	TranslationRotationValue X_Translation, 
	double X_TranslationSpringModulus, 
	TranslationRotationValue Y_Translation, 
	double Y_TranslationSpringModulus, 
	TranslationRotationValue Z_Translation, 
	double Z_TranslationSpringModulus, 
	TranslationRotationValue X_Rotation, 
	double X_RotationSpringModulus
)

member NewLineBoundaryConditions : 
        hostElement : Element * 
        X_Translation : TranslationRotationValue * 
        X_TranslationSpringModulus : float * 
        Y_Translation : TranslationRotationValue * 
        Y_TranslationSpringModulus : float * 
        Z_Translation : TranslationRotationValue * 
        Z_TranslationSpringModulus : float * 
        X_Rotation : TranslationRotationValue * 
        X_RotationSpringModulus : float -> BoundaryConditions

Examples

bool CreateLineConditionsWithElement(AnalyticalMember column, Autodesk.Revit.Creation.Document docCreation)
  {
      if (column.StructuralRole != AnalyticalStructuralRole.StructuralRoleColumn)
      {
          throw new Exception("This sample only works for columns.");
      }

      // Create the new line boundary conditions
      BoundaryConditions condition = docCreation.NewLineBoundaryConditions(column, TranslationRotationValue.Fixed, 0,
                                                                                   TranslationRotationValue.Fixed, 0,
                                                                                   TranslationRotationValue.Fixed, 0,
                                                                                   TranslationRotationValue.Fixed, 0);
      return (null != condition);
  }

Private Function CreateLineConditionsWithElement(column As FamilyInstance, docCreation As Autodesk.Revit.Creation.Document) As Boolean
    If StructuralType.Column <> column.StructuralType Then
        Throw New Exception("This sample only works for columns.")
    End If

    ' Create the new line boundary conditions
    Dim condition As BoundaryConditions = docCreation.NewLineBoundaryConditions(column, TranslationRotationValue.Fixed, 0, TranslationRotationValue.Fixed, 0, TranslationRotationValue.Fixed, _
        0, TranslationRotationValue.Fixed, 0)
    Return (condition IsNot Nothing)
End Function

Parameters

Parameter	Type	Description
hostElement	Element	A Beam.
X_Translation	TranslationRotationValue	A value indicating the X axis translation option.
X_TranslationSpringModulus	Double	Translation Spring Modulus for X axis. Ignored if X_Translation is not "Spring".
Y_Translation	TranslationRotationValue	A value indicating the Y axis translation option.
Y_TranslationSpringModulus	Double	Translation Spring Modulus for Y axis. Ignored if Y_Translation is not "Spring".
Z_Translation	TranslationRotationValue	A value indicating the Z axis translation option.
Z_TranslationSpringModulus	Double	Translation Spring Modulus for Z axis. Ignored if Z_Translation is not "Spring".
X_Rotation	TranslationRotationValue	A value indicating the option for rotation about the X axis.
X_RotationSpringModulus	Double	Rotation Spring Modulus for X axis. Ignored if X_Rotation is not "Spring"

Return Value

Type	Description
BoundaryConditions	If successful, NewLineBoundaryConditions returns an object for the newly created BoundaryConditions with the BoundaryType = 1 - "Line". is returned if the operation fails.

Exceptions

Exception	Condition
ArgumentException	Thrown if the host element does not exist in the given document.