2026 Class
Changes 3
C

SketchEditScope

Description:
A SketchEditScope allows an application to create and maintain an editing session for a Sketch.
Remarks:
Start/end of a SketchEditScope will start/end a transaction group. After a SketchEditScope is started, an application can start transactions and edit the sketch. Individual transactions the application creates inside SketchEditScope 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 SketchEditScope constructor.
Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.EditScope
    Autodesk.Revit.DB.SketchEditScope
public class SketchEditScope : EditScope
Name Return Type Description Inherited From
C SketchEditScope(Document, String) None Instantiates a SketchEditScope object.
Name Return Type Description Inherited From
M Cancel() None Cancels the edit scope. (Inherited from EditScope ) EditScope
M Commit(IFailuresPreprocessor) None Finishes the edit scope. (Inherited from EditScope ) EditScope
M Dispose() None (Inherited from EditScope ) EditScope
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M IsElementWithoutSketch(ElementId) Boolean Validates if an element can have a sketch but currently does not.
M IsSketchEditingSupported(ElementId) Boolean Checks whether sketch can be edited.
M IsSketchEditingSupportedForSketchBasedElement(ElementId) Boolean Checks whether the element supports sketch editing.
M Start(ElementId) None Starts a sketch edit mode.
M StartWithNewSketch(ElementId) None Starts a sketch edit mode for an element which, at this moment, doesn't have a sketch.
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object
Name Return Type Description Inherited From
P IsActive bool Tells if the EditScope is active. In other words, the EditScope has started but not committed/canceled yet. (Inherited from EditScope ) EditScope
P IsPermitted bool Tells if the edit scope is permitted to start. (Inherited from EditScope ) EditScope
P IsValidObject Boolean Specifies whether the .NET object represents a valid Revit entity. (Inherited from EditScope ) EditScope