ViewSectionCreateCallout Method |
Creates a new callout view.
Namespace: Autodesk.Revit.DBAssembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)
Syntaxpublic static View CreateCallout(
Document document,
ElementId parentViewId,
ElementId viewFamilyTypeId,
XYZ point1,
XYZ point2
)
Public Shared Function CreateCallout (
document As Document,
parentViewId As ElementId,
viewFamilyTypeId As ElementId,
point1 As XYZ,
point2 As XYZ
) As View
public:
static View^ CreateCallout(
Document^ document,
ElementId^ parentViewId,
ElementId^ viewFamilyTypeId,
XYZ^ point1,
XYZ^ point2
)
static member CreateCallout :
document : Document *
parentViewId : ElementId *
viewFamilyTypeId : ElementId *
point1 : XYZ *
point2 : XYZ -> View
Parameters
- document Document
-
The document to which the new callout will be added.
- parentViewId ElementId
-
The view in which the callout appears.
Callouts can be created in FloorPlan, CeilingPlan, StructuralPlan, Section, Elevation,
and Detail views.
- viewFamilyTypeId ElementId
-
The id of the ViewFamilyType which will be used by the new callout ViewSection.
Detail ViewFamilyTypes can be used in all parent views except for CeilingPlan and Drafting views.
FloorPlan, CeilingPlan, StructuralPlan, Section, and Elevation ViewFamilyTypes may be
be used in parent views that also use a type with the same ViewFamily enum value.
For example, in StructuralPlan parent views both StructuralPlan and Detail ViewFamilyTypes are allowed.
- point1 XYZ
-
Determines the extents of the callout symbol in the parent view.
- point2 XYZ
-
Determine the extents of the callout symbol in the parent view.
Return Value
View
The new callout view. The view will be either a ViewSection, ViewPlan or ViewDetail.
ExceptionsException | Condition |
---|
ArgumentException |
Non-reference callouts are not allowed in parent views of this type.
-or-
Callouts of the supplied ViewFamilyType are not allowed in the parent view.
-or-
point1 and point2 do not differ when projected onto a plane perpendicular to the view direction.
-or-
Callout view 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
The extents of new callout are determined by using the two argument points as the
opposing corners of a rectangle which is aligned to the directions of the parent view.
The callout's near and far cut planes will match those of the parent view.
The new view will receive a unique name.
See Also