SketchPlaneCreate(Document, Plane) Method

Creates a new sketch plane from a geometric plane.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public static SketchPlane Create(
	Document document,
	Plane plane
)

Public Shared Function Create ( 
	document As Document,
	plane As Plane
) As SketchPlane

public:
static SketchPlane^ Create(
	Document^ document, 
	Plane^ plane
)

static member Create : 
        document : Document * 
        plane : Plane -> SketchPlane

Parameters

document Document: The document.
plane Plane: The geometry plane where the sketch plane will be created.

Return Value

SketchPlane
The newly created sketch plane.

Exceptions

Exception	Condition
ArgumentException	Sketch plane creation is not allowed in this family.
ArgumentNullException	A non-optional argument was null
ModificationForbiddenException	The document is in failure mode: an operation has failed, and Revit requires the user to either cancel the operation or fix the problem (usually by deleting certain elements). -or- The document is being loaded, or is in the midst of another sensitive process.
ModificationOutsideTransactionException	The document has no open transaction.

Remarks

There will not be a reference relationship established from the sketch plane to the input face. To create a SketchPlane with a reference to other geometry, use the overload with a Reference input.

Example

C++

Copy

public static SketchPlane CreateSketchPlane(Autodesk.Revit.DB.Document document, Plane plane)
{
    SketchPlane sketchPlane = null;

    // create a sketch plane using Geometry.Plane
    sketchPlane = SketchPlane.Create(document, plane);

    // throw exception if creation failed
    if (null == sketchPlane)
    {
        throw new Exception("Create the sketch plane failed.");
    }

    return sketchPlane;
}

Public Shared Function CreateSketchPlane(document As Autodesk.Revit.DB.Document, plane As Plane) As SketchPlane
    Dim sketchPlane__1 As SketchPlane = Nothing

    ' create a sketch plane using Geometry.Plane
    sketchPlane__1 = SketchPlane.Create(document, plane)

    ' throw exception if creation failed
    If sketchPlane__1 Is Nothing Then
        Throw New Exception("Create the sketch plane failed.")
    End If

    Return sketchPlane__1
End Function

Reference

SketchPlane Class

Create Overload

Autodesk.Revit.DB Namespace