Namespace: Autodesk.Revit.DB.Structure Class: StructuralFramingUtils

StructuralFramingUtils.IsJoinAllowedAtEnd

Method

Description:
Identifies if the indicated end of the framing element is allowed to join to others.

Syntax

public static bool IsJoinAllowedAtEnd(
	FamilyInstance familyInstance,
	int end
)

Public Shared Function IsJoinAllowedAtEnd ( 
	familyInstance As FamilyInstance,
	end As Integer
) As Boolean

public:
static bool IsJoinAllowedAtEnd(
	FamilyInstance^ familyInstance, 
	int end
)

static member IsJoinAllowedAtEnd : 
        familyInstance : FamilyInstance * 
        end : int -> bool

Parameters

Parameter	Type	Description
familyInstance	FamilyInstance	The FamilyInstance, which must be of a structural framing category.
end	Int32	The index of the end (0 for the start, 1 for the end).

Return Value

Type	Description
Boolean	True if it is allowed to join. False if it is disallowed.

Exceptions

Exception	Condition
ArgumentNullException	A non-optional argument was null
ArgumentOutOfRangeException	end must be 0 or 1.
ArgumentsInconsistentException	The input familyInstance is not of a structural framing category.