BeamSystemCreate(Document, IListCurve, SketchPlane, XYZ, Boolean) Method |
Creates a new BeamSystem with specified profile curves.
Namespace: Autodesk.Revit.DBAssembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntaxpublic static BeamSystem Create(
Document document,
IList<Curve> profile,
SketchPlane sketchPlane,
XYZ direction,
bool is3d
)
Public Shared Function Create (
document As Document,
profile As IList(Of Curve),
sketchPlane As SketchPlane,
direction As XYZ,
is3d As Boolean
) As BeamSystem
public:
static BeamSystem^ Create(
Document^ document,
IList<Curve^>^ profile,
SketchPlane^ sketchPlane,
XYZ^ direction,
bool is3d
)
static member Create :
document : Document *
profile : IList<Curve> *
sketchPlane : SketchPlane *
direction : XYZ *
is3d : bool -> BeamSystem
Parameters
- document Document
-
The document in which the new BeamSystem is created.
- profile IListCurve
-
The profile of the BeamSystem.
- sketchPlane SketchPlane
-
The work-plane for the BeamSystem.
- direction XYZ
-
The direction is the direction of the BeamSystem.
- is3d Boolean
-
Whether the BeamSystem is 3D. If the BeamSystem is 3D, the sketchPlane must be a level, otherwise an exception will be thrown.
Return Value
BeamSystem
If successful, a new BeamSystem object will be returned.
ExceptionsException | Condition |
---|
ArgumentException |
SketchPlane is not valid for BeamSystem creation.
-or-
The input profile contains at least one helical curve and is not supported for this operation.
-or-
The profile curves must be in the sketch plane.
|
ArgumentNullException |
A non-optional argument was null
|
InvalidOperationException |
The BeamSystem is 3D, but the SketchPlane is not a level.
|
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.
|
See Also