NumberSystemCreate(Document, ElementId, LinkElementId, StairsNumberSystemReferenceOption, LinkElementId) Method |
Creates a new instance of a NumberSystem associated to a host element, a view, and a reference level of stairs if in a multistory stairs.
Namespace: Autodesk.Revit.DBAssembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntaxpublic static NumberSystem Create(
Document document,
ElementId viewId,
LinkElementId hostElementId,
StairsNumberSystemReferenceOption referenceOption,
LinkElementId placementLevelId
)
Public Shared Function Create (
document As Document,
viewId As ElementId,
hostElementId As LinkElementId,
referenceOption As StairsNumberSystemReferenceOption,
placementLevelId As LinkElementId
) As NumberSystem
public:
static NumberSystem^ Create(
Document^ document,
ElementId^ viewId,
LinkElementId^ hostElementId,
StairsNumberSystemReferenceOption referenceOption,
LinkElementId^ placementLevelId
)
static member Create :
document : Document *
viewId : ElementId *
hostElementId : LinkElementId *
referenceOption : StairsNumberSystemReferenceOption *
placementLevelId : LinkElementId -> NumberSystem
Parameters
- document Document
-
The document.
- viewId ElementId
-
The view in which the NumberSystem will be created.
- hostElementId LinkElementId
-
The host id on which the NumberSystem will be created.
- referenceOption StairsNumberSystemReferenceOption
-
The reference option of the NumberSystem.
- placementLevelId LinkElementId
-
The id of the level on which the NumberSystem will be placed. The placement level must be one of the base levels of a stairs group members. It is suggested to
get the level from MultistoryStairs.GetStairsPlacementLevels().
Return Value
NumberSystem
The created NumberSystem.
ExceptionsException | Condition |
---|
ArgumentException |
viewId is not valid for placement of a NumberSystem (only floor plan views and elevation views are permitted).
-or-
hostElementId is not valid as a host for NumberSystem (only StairsRun elements are permitted in this release).
-or-
The reference option is not valid for a NumberSystem.
-or-
The placementLevelId is not one of the stairs base levels.
-or-
The hostElementId already has a number system.
|
ArgumentNullException |
A non-optional argument was null
|
ArgumentOutOfRangeException |
A value passed for an enumeration argument is not a member of that enumeration
|
Remarks
In multistory stairs, a stairs element could be a stair group or individual stair.
This method allows to add a NumberSystem for a run of an individual stairs or a stairs group member on the placementLevelId.
See Also