2027 Members
Changes 0
M

Form Methods

Name Return Type Description Inherited From
M AddEdge(Reference, Reference) None Add an edge to the form, connecting two edges on same/different profile, by a pair of specified points.
M 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.
M 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.
M AddProfile(Reference, Double) Int32 Add a profile into the form, by a specified edge/param.
M ArePhasesModifiable() Boolean Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element ) Element
M CanBeHidden(View) Boolean Indicates if the element can be hidden in the view. (Inherited from Element ) Element
M CanBeLocked() Boolean Identifies if the element can be locked. (Inherited from Element ) Element
M CanDeleteSubelement(Subelement) Boolean Checks if given subelement can be removed from the element. (Inherited from Element ) Element
M CanHaveTypeAssigned() Boolean Identifies if the element can have a type assigned. (Inherited from Element ) Element
M CanManipulateProfile(Int32) Boolean Tell if a profile can be deleted/moved/rotated.
M CanManipulateSubElement(Reference) Boolean Tell if a sub element can be deleted/moved/rotated/scaled.
M ChangeTypeId(ElementId) ElementId Changes the type of the element. (Inherited from Element ) Element
M 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.
M DeleteEntity(Schema) Boolean Deletes the existing entity created by %schema% in the element (Inherited from Element ) Element
M DeleteProfile(Int32) None Delete a profile of the form.
M DeleteSubelement(Subelement) Boolean Removes a subelement from the element. (Inherited from Element ) Element
M DeleteSubElement(Reference) None Delete a face/edge/curve/vertex of the form, specified by a reference.
M DeleteSubelements(IList<Subelement>) Boolean Removes the subelements from the element. (Inherited from Element ) Element
M Dispose() None (Inherited from Element ) Element
M Equals None Determines whether the specified object is equal to the current object. (Inherited from Object ) Object
M EvaluateAllParameterValues() IList<EvaluatedParameter> Evaluates all the parameters' values of the element. (Inherited from Element ) Element
M EvaluateParameterValues(ISet<ElementId>) IList<EvaluatedParameter> Evaluate the parameters' values of the element on the given parameter ID set. (Inherited from Element ) Element
M GetControlPoints(Reference) ReferenceArray Given an edge or a curve or a face, return all control points lying on it (in form of geometry references).
M GetCurvesAndEdgesReference(Reference) ReferenceArray Given a point, return all edges and curves that it is lying on.
M GetDependentElements(ElementFilter) IList<ElementId> Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element ) Element
M GetEntity(Schema) Entity 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
M GetEntitySchemaGuids() IList<Guid> Returns the Schema guids of any Entities stored in this element. (Inherited from Element ) Element
M GetExternalFileReference() ExternalFileReference Gets information pertaining to the external file referenced by the element. (Inherited from Element ) Element
M GetExternalResourceReference(ExternalResourceType) ExternalResourceReference Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) Element
M GetExternalResourceReferenceExpanded(ExternalResourceType) IList<ExternalResourceReference> Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) Element
M GetExternalResourceReferences() IDictionary<ExternalResourceType,ExternalResourceReference> Gets the map of the external resource references referenced by the element. (Inherited from Element ) Element
M GetExternalResourceReferencesExpanded() ExternalResourceType Gets the expanded map of the external resource references referenced by the element. (Inherited from Element ) Element
M GetGeneratingElementIds(GeometryObject) ICollection<ElementId> Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element ) Element
M GetGeometryObjectFromReference(Reference) GeometryObject Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element ) Element
M GetHashCode None Serves as the default hash function. (Inherited from Object ) Object
M GetMaterialArea(ElementId, Boolean) Double Gets the area of the material with the given id. (Inherited from Element ) Element
M GetMaterialIds(Boolean) ICollection<ElementId> Gets the element ids of all materials present in the element. (Inherited from Element ) Element
M GetMaterialVolume(ElementId) Double Gets the volume of the material with the given id. (Inherited from Element ) Element
M GetMonitoredLinkElementIds() IList<ElementId> Provides the link instance IDs when the element is monitoring. (Inherited from Element ) Element
M GetMonitoredLocalElementIds() IList<ElementId> Provides the local element IDs when the element is monitoring. (Inherited from Element ) Element
M GetOrderedParameters() IList<Parameter> Gets the parameters associated to the element in order. (Inherited from Element ) Element
M GetParameter(ForgeTypeId) Parameter Retrieves a parameter from the element given identifier. (Inherited from Element ) Element
M GetParameterFormatOptions(ElementId) FormatOptions Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element ) Element
M GetParameters(String) IList<Parameter> Retrieves the parameters from the element via the given name. (Inherited from Element ) Element
M GetPathCurveIndexByCurveReference(Reference) Int32 Given a reference to certain curve in the path, return its index.
M GetPhaseStatus(ElementId) ElementOnPhaseStatus Gets the status of a given element in the input phase (Inherited from Element ) Element
M GetProfileAndCurveLoopIndexFromReference(Reference, Int32%, Int32%) None Given a reference to certain curve or edge, get the index of its profile and curve loop respectively.
M GetSubelements() IList<Subelement> Returns the collection of element subelements. (Inherited from Element ) Element
M GetType None Gets the Type of the current instance. (Inherited from Object ) Object
M GetTypeId() ElementId Returns the identifier of this element's type. (Inherited from Element ) Element
M GetValidTypes() ICollection<ElementId> Obtains a set of types that are valid for this element. (Inherited from Element ) Element
M GetVisibility() FamilyElementVisibility Gets the visibility for the generic form. (Inherited from GenericForm ) GenericForm
M HasPhases() Boolean Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element ) Element
M IsAutoCreaseEdge(Reference) Boolean Tell if an edge is an auto-crease on a top/bottom cap face.
M IsBeginningFace(Reference) Boolean Given a face, tell if it is a beginning cap face.
M IsConnectingEdge(Reference) Boolean Tell if an edge is a connecting edge on a side face. Connecting edges connect vertices on different profiles.
M IsCreatedPhaseOrderValid(ElementId) Boolean Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) Element
M IsCurveReference(Reference) Boolean Tell if the pick is the reference to a curve of the form.
M IsDemolishedPhaseOrderValid(ElementId) Boolean Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) Element
M IsEdgeReference(Reference) Boolean Tell if the pick is the reference to an edge of the form.
M IsEndFace(Reference) Boolean Given a face, tell if it is an end cap face.
M IsExternalFileReference() Boolean Determines whether this Element represents an external file. (Inherited from Element ) Element
M IsFaceReference(Reference) Boolean Tell if the pick is the reference to a face of the form.
M IsHidden(View) Boolean Identifies if the element has been permanently hidden in the view. (Inherited from Element ) Element
M IsMonitoringLinkElement() Boolean Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element ) Element
M IsMonitoringLocalElement() Boolean Indicate whether an element is monitoring other local elements. (Inherited from Element ) Element
M IsPhaseCreatedValid(ElementId) Boolean Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element ) Element
M IsPhaseDemolishedValid(ElementId) Boolean Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element ) Element
M IsProfileEdge(Reference) Boolean Tell if an edge or curve is generated from a profile.
M IsReferenceOnlyProfile(Int32) Boolean Tell if the profile is made by referencing existing geometry in the Revit model.
M IsSideFace(Reference) Boolean Given a face, tell if it is a side face.
M IsValidType(ElementId) Boolean Checks if given type is valid for this element. (Inherited from Element ) Element
M IsVertexReference(Reference) Boolean Tell if the pick is the reference to a vertex of the form.
M LookupParameter(String) Parameter Attempts to find a parameter on the element which has the given name. (Inherited from Element ) Element
M MoveProfile(Int32, XYZ) None Move a profile of the form, specified by a reference, and an offset vector.
M MoveSubElement(Reference, XYZ) None Move a face/edge/curve/vertex of the form, specified by a reference, and an offset vector.
M RefersToExternalResourceReference(ExternalResourceType) Boolean Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element ) Element
M RefersToExternalResourceReferences() Boolean Determines whether this Element uses external resources. (Inherited from Element ) Element
M Rehost(Reference, XYZ) None Rehost Form to edge, face or curve.
M Rehost(SketchPlane, XYZ) None Rehost Form to sketch plane
M RotateProfile(Int32, Line, Double) None Rotate a profile of the form, by a specified angle around a given axis.
M RotateSubElement(Reference, Line, Double) None Rotate a face/edge/curve/vertex of the form, by a specified angle around a given axis.
M ScaleProfile(Int32, Double, XYZ) None Scale a profile of the form, by a specified origin and scale factor.
M ScaleSubElement(Reference, Double, XYZ) None Scale a face/edge/curve/vertex of the form, by a specified origin and scale factor.
M SetEntity(Entity) None Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. (Inherited from Element ) Element
M SetVisibility(FamilyElementVisibility) None Sets the visibility for the generic form. (Inherited from GenericForm ) GenericForm
M ToString None Returns a string that represents the current object. (Inherited from Object ) Object