SiteSubRegionCreate(Document, IListCurveLoop, ElementId) Method |
Note: This API is now obsolete.
Creates a new SiteSubRegion element with assigned TopographySurface to be hosted and adds it to the document.
Namespace: Autodesk.Revit.DB.ArchitectureAssembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntax[ObsoleteAttribute("This method is deprecated in Revit 2024 with the introduction of the new Toposolid elements. It is recommended that Toposolid elements should be used in place of TopographySurface elements.")]
public static SiteSubRegion Create(
Document document,
IList<CurveLoop> curveLoops,
ElementId hostTopoSurfaceId
)
<ObsoleteAttribute("This method is deprecated in Revit 2024 with the introduction of the new Toposolid elements. It is recommended that Toposolid elements should be used in place of TopographySurface elements.")>
Public Shared Function Create (
document As Document,
curveLoops As IList(Of CurveLoop),
hostTopoSurfaceId As ElementId
) As SiteSubRegion
public:
[ObsoleteAttribute(L"This method is deprecated in Revit 2024 with the introduction of the new Toposolid elements. It is recommended that Toposolid elements should be used in place of TopographySurface elements.")]
static SiteSubRegion^ Create(
Document^ document,
IList<CurveLoop^>^ curveLoops,
ElementId^ hostTopoSurfaceId
)
[<ObsoleteAttribute("This method is deprecated in Revit 2024 with the introduction of the new Toposolid elements. It is recommended that Toposolid elements should be used in place of TopographySurface elements.")>]
static member Create :
document : Document *
curveLoops : IList<CurveLoop> *
hostTopoSurfaceId : ElementId -> SiteSubRegion
Parameters
- document Document
-
The document to be modified.
- curveLoops IListCurveLoop
-
The boundary of the subregion.
- hostTopoSurfaceId ElementId
-
The element id of a TopographySurface assigned to be a host of new created SiteSubRegion.
Return Value
SiteSubRegion
The new SubRegion surface.
ExceptionsException | Condition |
---|
ArgumentException |
The input curve loops cannot compose a valid boundary, that means:
no curve loop is contained in the given collection;
these curve loops intersect with each other for some of them;
or each curve loop is not closed individually;
or each curve loop is not planar;
or each curve loop is not in a plane parallel to the horizontal(XY) plane.
-or-
The ElementId hostTopoSurfaceId does not represent a TopographySurface.
|
ArgumentNullException |
A non-optional argument was null
|
InvalidOperationException |
Failed to create the Sketch for the boundary of the current Subregion.
-or-
Cannot associate the new subregion with the assigned host because there is no geometric overlap, or they have mismatched design options.
-or-
The given curve loops intersect with curve loops of existing SiteSubRegions hosted on the same TopographySurface.
-or-
The boundary of SubRegion is entirely inside or overlaps at least one existing BuildingPad hosted on the same TopographySurface. This behavior is not allowed.
|
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
This will create a new TopographySurface element which represents a subregion with a host TopographySurface assigned.
If you need access to this Element you can obtain it from the TopographySurface property.
See
TopographySurface for details.
See Also