StairsEditScope
Description:
StairsEditScope allows user to maintain a stairs-editing session.
StairsEditScope allows user to maintain a stairs-editing session.
Remarks:
Start/end of a StairsEditScope will start/end a transaction group. After a StairsEditScope is started, user can start transactions and edit the stairs. Individual transactions the user creates inside StairsEditScope will not appear in the undo menu. All transactions committed during the edit mode will be merged into a single one which will bear the given name passed into StairsEditScope constructor.
Start/end of a StairsEditScope will start/end a transaction group. After a StairsEditScope is started, user can start transactions and edit the stairs. Individual transactions the user creates inside StairsEditScope will not appear in the undo menu. All transactions committed during the edit mode will be merged into a single one which will bear the given name passed into StairsEditScope constructor.
public class StairsEditScope : EditScope
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| StairsEditScope(Document, String) | None | Instantiates a StairsEditScope object. |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| Cancel() | None | Cancels the edit scope. (Inherited from EditScope ) | EditScope |
| Commit(IFailuresPreprocessor) | None | Finishes the edit scope. (Inherited from EditScope ) | EditScope |
| Dispose() | None | (Inherited from EditScope ) | EditScope |
| Equals | None | Determines whether the specified object is equal to the current object. (Inherited from Object ) | Object |
| GetHashCode | None | Serves as the default hash function. (Inherited from Object ) | Object |
| GetType | None | Gets the Type of the current instance. (Inherited from Object ) | Object |
| Start(ElementId) | ElementId | Starts an stairs edit mode for an existing Stairs element | |
| Start(ElementId, ElementId) | ElementId | Creates a new empty stairs element with a default stairs type in the specified levels and then starts stairs edit mode and editing the new stairs. | |
| ToString | None | Returns a string that represents the current object. (Inherited from Object ) | Object |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| IsActive | bool | Tells if the EditScope is active. In other words, the EditScope has started but not committed/canceled yet. (Inherited from EditScope ) | EditScope |
| IsPermitted | bool | Tells if the edit scope is permitted to start. (Inherited from EditScope ) | EditScope |
| IsValidObject | Boolean | Specifies whether the .NET object represents a valid Revit entity. (Inherited from EditScope ) | EditScope |