StructuralConnectionType.ValidFamilySymbolId
Method
Description:
Checks whether the family symbol id is allowed for StructuralConnectionTypes with the given value for the applyTo property.
Checks whether the family symbol id is allowed for StructuralConnectionTypes with the given value for the applyTo property.
Syntax
public static bool ValidFamilySymbolId(
Document doc,
StructuralConnectionApplyTo applyTo,
ElementId familySymbolId
)
Parameters
Parameter | Type | Description |
---|---|---|
doc | Document | |
applyTo | StructuralConnectionApplyTo | |
familySymbolId | ElementId |
Return Value
Type | Description |
---|---|
Boolean | True if %familySymbolId% is invalidElementId; or if it is the id of a FamilySymbol of category "Connection Symbols" (OST_StructConnectionSymbols) with its "Apply To" parameter set to match the applyTo property. Returns false otherwise. |
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | A non-optional argument was null |
ArgumentOutOfRangeException | A value passed for an enumeration argument is not a member of that enumeration |