Form Methods


The Form type exposes the following members.

Methods

  NameDescription
Public methodAddEdge(Reference, Reference)
Add an edge to the form, connecting two edges on same/different profile, by a pair of specified points.
Public methodAddEdge(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.
Public methodAddEdge(Reference, Double, Reference, Double)
Add an edge to the form, connecting two edges on same/different profile, by a pair of specified edge/param.
Public methodAddProfile
Add a profile into the form, by a specified edge/param.
Public methodArePhasesModifiable
Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.
(Inherited from Element.)
Public methodCanBeHidden
Indicates if the element can be hidden in the view.
(Inherited from Element.)
Public methodCanBeLocked
Identifies if the element can be locked.
(Inherited from Element.)
Public methodCanDeleteSubelement
Checks if given subelement can be removed from the element.
(Inherited from Element.)
Public methodCanHaveTypeAssigned
Identifies if the element can have a type assigned.
(Inherited from Element.)
Public methodCanManipulateProfile
Tell if a profile can be deleted/moved/rotated.
Public methodCanManipulateSubElement
Tell if a sub element can be deleted/moved/rotated/scaled.
Public methodChangeTypeId(ElementId)
Changes the type of the element.
(Inherited from Element.)
Public methodConstrainProfiles
Constrain form profiles using the specified profile as primary. This is an advanced version of property "AreProfilesConstrained", allowing specify the primary profile.
Public methodDeleteEntity
Deletes the existing entity created by %schema% in the element
(Inherited from Element.)
Public methodDeleteProfile
Delete a profile of the form.
Public methodDeleteSubelement
Removes a subelement from the element.
(Inherited from Element.)
Public methodDeleteSubElement
Delete a face/edge/curve/vertex of the form, specified by a reference.
Public methodDeleteSubelements
Removes the subelements from the element.
(Inherited from Element.)
Public methodDispose (Inherited from Element.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodEvaluateAllParameterValues
Evaluates all the parameters' values of the element.
(Inherited from Element.)
Public methodEvaluateParameterValues
Evaluate the parameters' values of the element on the given parameter ID set.
(Inherited from Element.)
Public methodGetControlPoints
Given an edge or a curve or a face, return all control points lying on it (in form of geometry references).
Public methodGetCurvesAndEdgesReference
Given a point, return all edges and curves that it is lying on.
Public methodGetDependentElements
Get all elements that, from a logical point of view, are the children of this Element.
(Inherited from Element.)
Public methodGetEntity
Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.
(Inherited from Element.)
Public methodGetEntitySchemaGuids
Returns the Schema guids of any Entities stored in this element.
(Inherited from Element.)
Public methodGetExternalFileReference
Gets information pertaining to the external file referenced by the element.
(Inherited from Element.)
Public methodGetExternalResourceReference
Gets the ExternalResourceReference associated with a specified external resource type.
(Inherited from Element.)
Public methodGetExternalResourceReferenceExpanded
Gets the collection of ExternalResourceReference associated with a specified external resource type.
(Inherited from Element.)
Public methodGetExternalResourceReferences
Gets the map of the external resource references referenced by the element.
(Inherited from Element.)
Public methodGetExternalResourceReferencesExpanded
Gets the expanded map of the external resource references referenced by the element.
(Inherited from Element.)
Public methodGetGeneratingElementIds
Returns the ids of the element(s) that generated the input geometry object.
(Inherited from Element.)
Public methodGetGeometryObjectFromReference
Retrieve one geometric primitive contained in the element given a reference.
(Inherited from Element.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetMaterialArea
Gets the area of the material with the given id.
(Inherited from Element.)
Public methodGetMaterialIds
Gets the element ids of all materials present in the element.
(Inherited from Element.)
Public methodGetMaterialVolume
Gets the volume of the material with the given id.
(Inherited from Element.)
Public methodGetMonitoredLinkElementIds
Provides the link instance IDs when the element is monitoring.
(Inherited from Element.)
Public methodGetMonitoredLocalElementIds
Provides the local element IDs when the element is monitoring.
(Inherited from Element.)
Public methodGetOrderedParameters
Gets the parameters associated to the element in order.
(Inherited from Element.)
Public methodGetParameter
Retrieves a parameter from the element given identifier.
(Inherited from Element.)
Public methodGetParameterFormatOptions
Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.
(Inherited from Element.)
Public methodGetParameters
Retrieves the parameters from the element via the given name.
(Inherited from Element.)
Public methodGetPathCurveIndexByCurveReference
Given a reference to certain curve in the path, return its index.
Public methodGetPhaseStatus
Gets the status of a given element in the input phase
(Inherited from Element.)
Public methodGetProfileAndCurveLoopIndexFromReference
Given a reference to certain curve or edge, get the index of its profile and curve loop respectively.
Public methodGetSubelements
Returns the collection of element subelements.
(Inherited from Element.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetTypeId
Returns the identifier of this element's type.
(Inherited from Element.)
Public methodGetValidTypes
Obtains a set of types that are valid for this element.
(Inherited from Element.)
Public methodGetVisibility
Gets the visibility for the generic form.
(Inherited from GenericForm.)
Public methodHasPhases
Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.
(Inherited from Element.)
Public methodIsAutoCreaseEdge
Tell if an edge is an auto-crease on a top/bottom cap face.
Public methodIsBeginningFace
Given a face, tell if it is a beginning cap face.
Public methodIsConnectingEdge
Tell if an edge is a connecting edge on a side face. Connecting edges connect vertices on different profiles.
Public methodIsCreatedPhaseOrderValid
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element.)
Public methodIsCurveReference
Tell if the pick is the reference to a curve of the form.
Public methodIsDemolishedPhaseOrderValid
Returns true if createdPhaseId and demolishedPhaseId are in order.
(Inherited from Element.)
Public methodIsEdgeReference
Tell if the pick is the reference to an edge of the form.
Public methodIsEndFace
Given a face, tell if it is an end cap face.
Public methodIsExternalFileReference
Determines whether this Element represents an external file.
(Inherited from Element.)
Public methodIsFaceReference
Tell if the pick is the reference to a face of the form.
Public methodIsHidden
Identifies if the element has been permanently hidden in the view.
(Inherited from Element.)
Public methodIsMonitoringLinkElement
Indicate whether an element is monitoring any elements in any linked models.
(Inherited from Element.)
Public methodIsMonitoringLocalElement
Indicate whether an element is monitoring other local elements.
(Inherited from Element.)
Public methodIsPhaseCreatedValid
Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.
(Inherited from Element.)
Public methodIsPhaseDemolishedValid
Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.
(Inherited from Element.)
Public methodIsProfileEdge
Tell if an edge or curve is generated from a profile.
Public methodIsReferenceOnlyProfile
Tell if the profile is made by referencing existing geometry in the Revit model.
Public methodIsSideFace
Given a face, tell if it is a side face.
Public methodIsValidType(ElementId)
Checks if given type is valid for this element.
(Inherited from Element.)
Public methodIsVertexReference
Tell if the pick is the reference to a vertex of the form.
Public methodLookupParameter
Attempts to find a parameter on the element which has the given name.
(Inherited from Element.)
Public methodMoveProfile
Move a profile of the form, specified by a reference, and an offset vector.
Public methodMoveSubElement
Move a face/edge/curve/vertex of the form, specified by a reference, and an offset vector.
Public methodRefersToExternalResourceReference
Determines whether this Element uses external resources associated with a specified external resource type.
(Inherited from Element.)
Public methodRefersToExternalResourceReferences
Determines whether this Element uses external resources.
(Inherited from Element.)
Public methodRehost(Reference, XYZ)
Rehost Form to edge, face or curve.
Public methodRehost(SketchPlane, XYZ)
Rehost Form to sketch plane
Public methodRotateProfile
Rotate a profile of the form, by a specified angle around a given axis.
Public methodRotateSubElement
Rotate a face/edge/curve/vertex of the form, by a specified angle around a given axis.
Public methodScaleProfile
Scale a profile of the form, by a specified origin and scale factor.
Public methodScaleSubElement
Scale a face/edge/curve/vertex of the form, by a specified origin and scale factor.
Public methodSetEntity
Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.
(Inherited from Element.)
Public methodSetVisibility
Sets the visibility for the generic form.
(Inherited from GenericForm.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)

See Also