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