Namespace:
Autodesk.Revit.DB
Form
Class
Description:
An object that represents a Form within the Autodesk Revit Massing Family.
An object that represents a Form within the Autodesk Revit Massing Family.
Remarks:
For any reference returned from a Form method, its GeometryObject will become invalid after a form modification method, e.g. MoveSubElement. Call the method on the Form object to retrieve the new reference if it is needed after the modification.
For any reference returned from a Form method, its GeometryObject will become invalid after a form modification method, e.g. MoveSubElement. Call the method on the Form object to retrieve the new reference if it is needed after the modification.
Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.CombinableElement
Autodesk.Revit.DB.GenericForm
Autodesk.Revit.DB.Form
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.CombinableElement
Autodesk.Revit.DB.GenericForm
Autodesk.Revit.DB.Form
Form Class Members:
| Name | Description | Inherited From |
|---|---|---|
| AreProfilesConstrained | Get/set if the form's profiles are constrained. | |
| AssemblyInstanceId | The id of the assembly instance to which the element belongs. (Inherited from Element ) | Element |
| BaseOffset | Retrieve/set the base offset of the form object. It is only valid for locked form. | |
| BoundingBox | Retrieves a box that circumscribes all geometry of the element. (Inherited from Element ) | Element |
| Category | Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element ) | Element |
| Combinations | The geometry combinations that this element belongs to. (Inherited from CombinableElement ) | CombinableElement |
| CreatedPhaseId | Id of a Phase at which the Element was created. (Inherited from Element ) | Element |
| CurveLoopReferencesOnProfile | The curve references in certain curve loop, specified by profile index and curve loop index. | |
| DemolishedPhaseId | Id of a Phase at which the Element was demolished. (Inherited from Element ) | Element |
| DesignOption | Returns the design option to which the element belongs. (Inherited from Element ) | Element |
| Document | Returns the Document in which the Element resides. (Inherited from Element ) | Element |
| Geometry | Retrieves the geometric representation of the element. (Inherited from Element ) | Element |
| GroupId | The id of the group to which an element belongs. (Inherited from Element ) | Element |
| HasOneOrMoreReferenceProfiles | Tell if the form has any reference profile. | |
| HasOpenGeometry | Tell if the form has an open geometry. | |
| Id | A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element ) | Element |
| IsInXRayMode | Get/set if the form is in X-Ray mode. | |
| IsModifiable | Identifies if the element is modifiable. (Inherited from Element ) | Element |
| IsSolid | Identifies if the GenericForm is a solid or a void element. (Inherited from GenericForm ) | GenericForm |
| IsTransient | Indicates whether an element is transient or permanent. (Inherited from Element ) | Element |
| IsValidObject | Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element ) | Element |
| LevelId | The id of the level associated with the element. (Inherited from Element ) | Element |
| Location | This property is used to find the physical location of an element within a project. (Inherited from Element ) | Element |
| Name | Get and Set the Name property (Inherited from GenericForm ) | GenericForm |
| OwnerViewId | The id of the view that owns the element. (Inherited from Element ) | Element |
| Parameter[BuiltInParameter] | Retrieves a parameter from the element given a parameter id. (Inherited from Element ) | Element |
| Parameter[Definition] | Retrieves a parameter from the element based on its definition. (Inherited from Element ) | Element |
| Parameter[Guid] | Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element ) | Element |
| Parameters | Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element ) | Element |
| ParametersMap | Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element ) | Element |
| PathCurveCount | The number of curves in the form path. | |
| PathCurveReference | The curve reference in the path, specified by curve index. | |
| Pinned | Identifies if the element has been pinned to prevent changes. (Inherited from Element ) | Element |
| ProfileCount | The number of profiles in the form. | |
| ProfileCurveLoopCount | The number of curve loops in certain profile, specified by profile index. | |
| Subcategory | The subcategory. (Inherited from GenericForm ) | GenericForm |
| TopOffset | Retrieve/set the top offset of the form object. It is only valid for locked form. | |
| UniqueId | A stable unique identifier for an element within the document. (Inherited from Element ) | Element |
| VersionGuid | Get the element version Guid. (Inherited from Element ) | Element |
| ViewSpecific | Identifies if the element is owned by a view. (Inherited from Element ) | Element |
| Visible | The visibility of the GenericForm. (Inherited from GenericForm ) | GenericForm |
| WorksetId | Get Id of the Workset which owns the element. (Inherited from Element ) | Element |
| Name | Description | Inherited From |
|---|---|---|
| AddEdge(Reference, Reference) | Add an edge to the form, connecting two edges on same/different profile, by a pair of specified points. | |
| AddEdge(Reference, XYZ) | Add an edge to the form, connecting two edges on different profiles, by a specified face of the form and a point on face. | |
| AddEdge(Reference, Double, Reference, Double) | Add an edge to the form, connecting two edges on same/different profile, by a pair of specified edge/param. | |
| AddProfile | Add a profile into the form, by a specified edge/param. | |
| ArePhasesModifiable | Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element ) | Element |
| CanBeHidden | Indicates if the element can be hidden in the view. (Inherited from Element ) | Element |
| CanBeLocked | Identifies if the element can be locked. (Inherited from Element ) | Element |
| CanDeleteSubelement | Checks if given subelement can be removed from the element. (Inherited from Element ) | Element |
| CanHaveTypeAssigned() | Identifies if the element can have a type assigned. (Inherited from Element ) | Element |
| CanManipulateProfile | Tell if a profile can be deleted/moved/rotated. | |
| CanManipulateSubElement | Tell if a sub element can be deleted/moved/rotated/scaled. | |
| ChangeTypeId(ElementId) | Changes the type of the element. (Inherited from Element ) | Element |
| ConstrainProfiles | Constrain form profiles using the specified profile as primary. This is an advanced version of property "AreProfilesConstrained", allowing specify the primary profile. | |
| DeleteEntity | Deletes the existing entity created by %schema% in the element (Inherited from Element ) | Element |
| DeleteProfile | Delete a profile of the form. | |
| DeleteSubelement | Removes a subelement from the element. (Inherited from Element ) | Element |
| DeleteSubElement | Delete a face/edge/curve/vertex of the form, specified by a reference. | |
| DeleteSubelements | Removes the subelements from the element. (Inherited from Element ) | Element |
| Dispose | (Inherited from Element ) | Element |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object ) | Object |
| EvaluateAllParameterValues | Evaluates all the parameters' values of the element. (Inherited from Element ) | Element |
| EvaluateParameterValues | Evaluate the parameters' values of the element on the given parameter ID set. (Inherited from Element ) | Element |
| GetControlPoints | Given an edge or a curve or a face, return all control points lying on it (in form of geometry references). | |
| GetCurvesAndEdgesReference | Given a point, return all edges and curves that it is lying on. | |
| GetDependentElements | Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element ) | Element |
| GetEntity | Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise. (Inherited from Element ) | Element |
| GetEntitySchemaGuids | Returns the Schema guids of any Entities stored in this element. (Inherited from Element ) | Element |
| GetExternalFileReference | Gets information pertaining to the external file referenced by the element. (Inherited from Element ) | Element |
| GetExternalResourceReference | Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) | Element |
| GetExternalResourceReferenceExpanded | Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) | Element |
| GetExternalResourceReferences | Gets the map of the external resource references referenced by the element. (Inherited from Element ) | Element |
| GetExternalResourceReferencesExpanded | Gets the expanded map of the external resource references referenced by the element. (Inherited from Element ) | Element |
| GetGeneratingElementIds | Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element ) | Element |
| GetGeometryObjectFromReference | Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element ) | Element |
| GetHashCode | Serves as the default hash function. (Inherited from Object ) | Object |
| GetMaterialArea | Gets the area of the material with the given id. (Inherited from Element ) | Element |
| GetMaterialIds | Gets the element ids of all materials present in the element. (Inherited from Element ) | Element |
| GetMaterialVolume | Gets the volume of the material with the given id. (Inherited from Element ) | Element |
| GetMonitoredLinkElementIds | Provides the link instance IDs when the element is monitoring. (Inherited from Element ) | Element |
| GetMonitoredLocalElementIds | Provides the local element IDs when the element is monitoring. (Inherited from Element ) | Element |
| GetOrderedParameters | Gets the parameters associated to the element in order. (Inherited from Element ) | Element |
| GetParameter | Retrieves a parameter from the element given identifier. (Inherited from Element ) | Element |
| GetParameterFormatOptions | Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element ) | Element |
| GetParameters | Retrieves the parameters from the element via the given name. (Inherited from Element ) | Element |
| GetPathCurveIndexByCurveReference | Given a reference to certain curve in the path, return its index. | |
| GetPhaseStatus | Gets the status of a given element in the input phase (Inherited from Element ) | Element |
| GetProfileAndCurveLoopIndexFromReference | Given a reference to certain curve or edge, get the index of its profile and curve loop respectively. | |
| GetSubelements | Returns the collection of element subelements. (Inherited from Element ) | Element |
| GetType | Gets the Type of the current instance. (Inherited from Object ) | Object |
| GetTypeId | Returns the identifier of this element's type. (Inherited from Element ) | Element |
| GetValidTypes() | Obtains a set of types that are valid for this element. (Inherited from Element ) | Element |
| GetVisibility | Gets the visibility for the generic form. (Inherited from GenericForm ) | GenericForm |
| HasPhases | Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element ) | Element |
| IsAutoCreaseEdge | Tell if an edge is an auto-crease on a top/bottom cap face. | |
| IsBeginningFace | Given a face, tell if it is a beginning cap face. | |
| IsConnectingEdge | Tell if an edge is a connecting edge on a side face. Connecting edges connect vertices on different profiles. | |
| IsCreatedPhaseOrderValid | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) | Element |
| IsCurveReference | Tell if the pick is the reference to a curve of the form. | |
| IsDemolishedPhaseOrderValid | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) | Element |
| IsEdgeReference | Tell if the pick is the reference to an edge of the form. | |
| IsEndFace | Given a face, tell if it is an end cap face. | |
| IsExternalFileReference | Determines whether this Element represents an external file. (Inherited from Element ) | Element |
| IsFaceReference | Tell if the pick is the reference to a face of the form. | |
| IsHidden | Identifies if the element has been permanently hidden in the view. (Inherited from Element ) | Element |
| IsMonitoringLinkElement | Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element ) | Element |
| IsMonitoringLocalElement | Indicate whether an element is monitoring other local elements. (Inherited from Element ) | Element |
| IsPhaseCreatedValid | Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element ) | Element |
| IsPhaseDemolishedValid | Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element ) | Element |
| IsProfileEdge | Tell if an edge or curve is generated from a profile. | |
| IsReferenceOnlyProfile | Tell if the profile is made by referencing existing geometry in the Revit model. | |
| IsSideFace | Given a face, tell if it is a side face. | |
| IsValidType(ElementId) | Checks if given type is valid for this element. (Inherited from Element ) | Element |
| IsVertexReference | Tell if the pick is the reference to a vertex of the form. | |
| LookupParameter | Attempts to find a parameter on the element which has the given name. (Inherited from Element ) | Element |
| MoveProfile | Move a profile of the form, specified by a reference, and an offset vector. | |
| MoveSubElement | Move a face/edge/curve/vertex of the form, specified by a reference, and an offset vector. | |
| RefersToExternalResourceReference | Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element ) | Element |
| RefersToExternalResourceReferences | Determines whether this Element uses external resources. (Inherited from Element ) | Element |
| Rehost(Reference, XYZ) | Rehost Form to edge, face or curve. | |
| Rehost(SketchPlane, XYZ) | Rehost Form to sketch plane | |
| RotateProfile | Rotate a profile of the form, by a specified angle around a given axis. | |
| RotateSubElement | Rotate a face/edge/curve/vertex of the form, by a specified angle around a given axis. | |
| ScaleProfile | Scale a profile of the form, by a specified origin and scale factor. | |
| ScaleSubElement | Scale a face/edge/curve/vertex of the form, by a specified origin and scale factor. | |
| SetEntity | Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. (Inherited from Element ) | Element |
| SetVisibility | Sets the visibility for the generic form. (Inherited from GenericForm ) | GenericForm |
| ToString | Returns a string that represents the current object. (Inherited from Object ) | Object |