MultistoryStairs.Pin
Method
Description:
Restores an unpinned stairs element back into the group of stairs governed by level height.
Restores an unpinned stairs element back into the group of stairs governed by level height.
Remarks:
If the level height of current story can be found among other stories, the stair will be added back into the group; Otherwise only the status will be changed to "pinned".
If the level height of current story can be found among other stories, the stair will be added back into the group; Otherwise only the status will be changed to "pinned".
Parameters
Parameter | Type | Description |
---|---|---|
levelId | ElementId | The base level id. If the level id belongs to the base level of an individual pinned stairs, it returns the stairs id directly. |
Return Value
Type | Description |
---|---|
Stairs | The stairs element which the pinned story belongs to. |
Exceptions
Exception | Condition |
---|---|
ArgumentException | There is no stairs instance at the given base levelId. |
ArgumentNullException | A non-optional argument was null |