M

Rebar

Name Return Type Description Inherited From
M ArePhasesModifiable() bool Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element .) Element
M CanApplyPresentationMode(View) bool Checks if a presentation mode can be applied for this rebar in the given view.
M CanBeHidden(View) bool Indicates if the element can be hidden in the view. (Inherited from Element .) Element
M CanBeLocked() bool Identifies if the element can be locked. (Inherited from Element .) Element
M CanBeMatchedWithMultipleShapes() bool Checks if this Rebar can be matched with multiple Rebar Shapes.
M CanDeleteSubelement(Subelement) bool Checks if given subelement can be removed from the element. (Inherited from Element .) Element
M CanHaveAnalyticalModel() bool Indicates whether the Element can have an Analytical Model. (Inherited from Element .) Element
M CanHaveTypeAssigned.() bool Identifies if the element can have a type assigned. (Inherited from Element .) Element
M CanSuppressFirstOrLastBar(View, Int32) bool Checks if the first or last bar in rebar set can be hidden in the given view.
M CanUseHookType(ElementId) bool Checks if the specified RebarHookType id is of a valid RebarHookType for the Rebar's RebarBarType
M ChangeTypeId(ElementId) ElementId Changes the type of the element. (Inherited from Element .) Element
M ClearPresentationMode(View) None Sets the presentation mode for this rebar set to the default (either for a single view, or for all views).
M ConstraintsCanBeEdited() bool For ShapeDriven Rebar: returns true, if the Rebar element's external constraints are available for editing using the RebarConstraintsManager class. Examples of where this method would return false are: Rebar in Groups (which do not have constraints), or legacy, sketch-based Rebar elements created before the introduction of RebarShape families in version 2009. For FreeForm rebar: constraints can be edited if there is a valid external server Guid assigned to that Rebar
M ContainsValidArcRadiiForStyleAndBarType(IList<Curve>, RebarStyle, RebarBarType) bool Checks that all arcs in the chain of curves have radii that are not less than minimum bend radius for bar type and style
M CreateFreeForm(Document, Guid, RebarBarType, Element) Rebar Creates a free form rebar that can have constraints.
M CreateFreeForm(Document, RebarBarType, Element, IList.CurveLoop., RebarFreeFormValidationResult.) Rebar Creates a free form rebar that will be unconstrained. Constraints can't be added later to this rebar.
M CreateFreeForm(Document, RebarBarType, Element, IList.IList.Curve., RebarFreeFormValidationResult.) Rebar Creates a free form rebar that will be unconstrained. Constraints can't be added later to this rebar.
M CreateFromCurves(Document, RebarStyle, RebarBarType, RebarHookType, RebarHookType, Element, XYZ, IList.Curve., RebarHookOrientation, RebarHookOrientation, Boolean, Boolean) nullNothingnullptr Creates a new instance of a shape driven Rebar element within the project.
M CreateFromCurves(Document, RebarStyle, RebarBarType, RebarHookType, RebarHookType, Element, XYZ, IList.Curve., RebarHookOrientation, RebarHookOrientation, Double, Double, ElementId, ElementId, Boolean, Boolean) nullNothingnullptr Creates a new instance of a shape driven Rebar element within the project.
M CreateFromCurvesAndShape(Document, RebarShape, RebarBarType, RebarHookType, RebarHookType, Element, XYZ, IList.Curve., RebarHookOrientation, RebarHookOrientation) nullNothingnullptr Creates a new instance of a shape driven Rebar element within the project. The instance will have the default shape parameters from the RebarShape. If the RebarShapeDefinesHooks flag in ReinforcementSettings has been set to true, then both the curves and hooks must match the RebarShape definition. Otherwise, the hooks can be different than the defaults specified in the RebarShape
M CreateFromCurvesAndShape(Document, RebarShape, RebarBarType, RebarHookType, RebarHookType, Element, XYZ, IList.Curve., RebarHookOrientation, RebarHookOrientation, Double, Double, ElementId, ElementId) nullNothingnullptr Creates a new instance of a shape driven Rebar element within the project. The instance will have the default shape parameters from the RebarShape. If the RebarShapeDefinesHooks flag in ReinforcementSettings has been set to true, then curves, hook types and hook rotation angles should match the rebar shape definition. Otherwise, the hooks can be different than the defaults specified in the RebarShape. If the RebarShapeDefinesEndTreatment flag in ReinforcementSettings has been set to true, then curves and end treatment types should match the rebar shape definition. Otherwise, the end treatment types can be different than the defaults specified in the RebarShape.
M CreateFromRebarShape(Document, RebarShape, RebarBarType, Element, XYZ, XYZ, XYZ) nullNothingnullptr Creates a new shape driven Rebar, as an instance of a RebarShape. The instance will have the default shape parameters from the RebarShape, and its location is based on the bounding box of the shape in the shape definition. Hooks are removed from the shape before computing its bounding box. If appropriate hooks can be found in the document, they will be assigned arbitrarily.
M DeleteEntity(Schema) bool Deletes the existing entity created by %schema% in the element (Inherited from Element .) Element
M DeleteSubelement(Subelement) bool Removes a subelement from the element. (Inherited from Element .) Element
M DeleteSubelements(IList<Subelement>) bool Removes the subelements from the element. (Inherited from Element .) Element
M Dispose() None (Inherited from Element .) Element
M DoesBarExistAtPosition(Int32) bool Checks whether a bar is included at the specified position.
M EnableHookLengthOverride(Boolean) None Enables or disables the ability to override hook lengths for this rebar instance.
M Equals None Determines whether the specified Object is equal to the current Object . (Inherited from Object .) Object .
M FindMatchingPredefinedPresentationMode(View) RebarPresentationMode Determines if there is a matching RebarPresentationMode for the current set of selected hidden and unhidden bars assigned to the given view.
M GetAllRebarShapeIds() IList<ElementId> Gets the ids of the RebarShapes elements that defines the shapes of the rebar.
M GetAnalyticalModel() Writeable Analytical Model. Retrieves writeable Analytical Model for Element. (Inherited from Element .) Element
M GetAnalyticalModelId() Element Id. Retrieves the Element Id of the Analytical Model Element for this Element. (Inherited from Element .) Element
M GetBarIndexFromReference(Reference) int Given a reference that represents a part of a bar, this method will return the bar index.
M GetBendData() RebarBendData Gets the RebarBendData, containing bar and hook information, of the instance.
M GetCenterlineCurves(Boolean, Boolean, Boolean, MultiplanarOption, Int32) IList<Curve> A chain of curves representing the centerline of the rebar.
M GetCouplerId(Int32) ElementId Get the id of the Rebar Coupler that is applied to the rebar at the specified end.
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 GetEndTreatmentTypeId(Int32) ElementId Get the id of the EndTreatmentType to be applied to the rebar.
M 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. (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 GetExternalResourceReferences() IDictionary Gets the full map of the external resource references referenced by the element. (Inherited from Element .) Element
M GetFreeFormAccessor() RebarFreeFormAccessor Returns an interface providing access to free-form properties and methods for this Rebar element.
M GetFullGeometryForView(View) GeometryElement Generates full geometry for the Rebar for a specific view.
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 a hash function for a particular type. (Inherited from Object .) Object .
M GetHookOrientation(Int32) RebarHookOrientation Returns the orientation of the hook plane at the start or at the end of the rebar with respect to the orientation of the first or the last curve and the plane normal.
M GetHookRotationAngle(Int32) double Gets the out of plane hook rotation angle at the specified end.
M GetHookTypeId(Int32) ElementId Get the id of the RebarHookType to be applied to the rebar.
M GetHostId() ElementId The element that contains the rebar.
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 GetMovedBarTransform(Int32) Transform Returns a transform representing the movement of the bar relative to its default position along the distribution path.
M GetOrderedParameters() IList<Parameter> Gets the parameters associated to the element in order. (Inherited from Element .) Element
M GetOverridableHookParameters(ISet<ElementId>, ISet<ElementId>, ISet<ElementId>, ISet<ElementId>) None Outputs the formula parameter ids defined in the RebarShape family which are associated with hook length and hook tangent length parameters.
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 GetParameterValueAtIndex(ElementId, Int32) ParameterValue Get the parameter value for a bar at the specified index. The parameter Id. The bar index in the rebar distribution. Accepts only values between 0 and NumberOfBarPositions-1. The ParameterValue for given parameterId and barPositionIndex. Throws exception if barPositionIndex is outside boundaries.
M GetPhaseStatus(ElementId) ElementOnPhaseStatus Gets the status of a given element in the input phase (Inherited from Element .) Element
M GetPresentationMode(View) The presentation mode. Gets the presentation mode for this rebar set when displayed in the given view.
M GetRebarConstraintsManager() RebarConstraintsManager Returns an object for managing the external constraints on the Rebar element
M GetReinforcementRoundingManager() The rounding manager. Returns an object for managing reinforcement rounding override settings.
M GetShapeDrivenAccessor() RebarShapeDrivenAccessor Returns an interface providing access to shape-driven properties and methods for this Rebar element.
M GetShapeId() ElementId Returns the id of the RebarShape element that defines the shape of the rebar.
M GetSubelements() IList<Subelement> Returns the collection of element subelements. (Inherited from Element .) Element
M GetTransformedCenterlineCurves(Boolean, Boolean, Boolean, MultiplanarOption, Int32) IList<Curve> A chain of curves representing the centerline of the rebar.
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 HasPhases() bool Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element .) Element
M HasPresentationOverrides(View) bool Identifies if this Rebar has overridden default presentation settings for the given view.
M HookAngleMatchesRebarShapeDefinition(Int32, ElementId) bool Checks that the hook angle of the specified RebarHookType matches the hook angle used in the Rebar's RebarShape at the specified end of the bar.
M IsBarHidden(View, Int32) bool Identifies if a given bar in this rebar set is hidden in this view.
M IsCreatedPhaseOrderValid(ElementId) bool Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element .) Element
M IsDemolishedPhaseOrderValid(ElementId) bool Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element .) Element
M IsExternalFileReference() bool Determines whether this Element represents an external file. (Inherited from Element .) Element
M IsHidden(View) bool Identifies if the element has been permanently hidden in the view. (Inherited from Element .) Element
M IsHookLengthOverrideEnabled() bool Returns True if the ability to override hook lengths is enabled for this rebar instance, False otherwise.
M IsMonitoringLinkElement() bool Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element .) Element
M IsMonitoringLocalElement() bool Indicate whether an element is monitoring other local elements. (Inherited from Element .) Element
M IsPhaseCreatedValid(ElementId) bool Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element .) Element
M IsPhaseDemolishedValid(ElementId) bool Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element .) Element
M IsRebarFreeForm() bool Returns true if the rebar is free form and false if shape driven.
M IsRebarInSection(View) bool Identifies if this Rebar is shown as a cross-section in the given view.
M IsRebarShapeDriven() bool Returns true if the rebar is shape driven and false if free form.
M IsSolidInView(View3D) bool Checks if this rebar element is shown solidly in a 3D view.
M IsUnobscuredInView(View) bool Checks if this rebar element is shown unobscured in a view.
M IsValidType(ElementId) bool Checks if given type is valid for this element. (Inherited from Element .) Element
M LookupParameter(String) nullNothingnullptr Attempts to find a parameter on the element which has the given name. (Inherited from Element .) Element
M MoveBarInSet(Int32, Transform) None This method applies the transformation matrix to the rebar bar at the desired position in the rebar set. If the bar was already moved, the method will concatenate the transformation matrix with the existing movement.
M RebarShapeMatchesCurvesAndHooks(RebarShape, RebarBarType, XYZ, IList<Curve>, RebarHookType, RebarHookType, RebarHookOrientation, RebarHookOrientation) bool Checks if rebarShape matches curves and hooks. If the RebarShapeDefinesHooks flag in ReinforcementSettings has been set to false, then this method will ignore the hook information.
M RebarShapeMatchesCurvesHooksAndEndTreatment(RebarShape, RebarBarType, XYZ, IList<Curve>, RebarHookType, RebarHookType, RebarHookOrientation, RebarHookOrientation, Double, Double, ElementId, ElementId) bool Checks if rebarShape matches curves, hooks and end treatment. If the RebarShapeDefinesHooks flag in ReinforcementSettings has been set to false, then this method will ignore the hook information. If the RebarShapeDefinesEndTreatment flag in ReinforcementSettings has been set to false, then this method will ignore the end treatment information.
M RefersToExternalResourceReference(ExternalResourceType) bool Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element .) Element
M RefersToExternalResourceReferences() bool Determines whether this Element uses external resources. (Inherited from Element .) Element
M ResetMovedBarTransform(Int32) None Reset the transformation representing the movement of the bar relative to its default position along the distribution path. The moved bar transform will be set to Identity.
M SetBarHiddenStatus(View, Int32, Boolean) None Sets the bar in this rebar set to be hidden or unhidden in the given view.
M SetBarIncluded(Boolean, Int32) None Sets if the bar at the desired index is included or not.
M SetEndTreatmentTypeId(Int32, ElementId) None Sets the id of the EndTreatmentType to be applied to the rebar. This can be done if and only if the end of the bar on which the end treatment is applied has no RebarCoupler on it, otherwise will throw an exception. If a RebarHookType is present at the rebar end, it will automatically set to invalidElementId.
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 SetHookOrientation(Int32, RebarHookOrientation) None Defines the orientation of the hook plane at the start or at the end of the rebar with respect to the orientation of the first or the last curve and the plane normal.
M SetHookRotationAngle(Double, Int32) None Sets the out of plane hook rotation angle at the specified end.
M SetHookTypeId(Int32, ElementId) None Set the id of the RebarHookType to be applied to the rebar. If an EndTreatmentType is present at the rebar end, it will automatically set to invalidElementId.
M SetHostId(Document, ElementId) None The element that contains the rebar.
M SetPresentationMode(View, RebarPresentationMode) None Sets the presentation mode for this rebar set when displayed in the given view.
M SetSolidInView(View3D, Boolean) None Sets this rebar element to be shown solidly in a 3D view.
M SetUnobscuredInView(View, Boolean) None Sets this rebar element to be shown unobscured in a view.
M ToString None Returns a string that represents the current object. (Inherited from Object .) Object .
Name Return Type Description Inherited From
P AssemblyInstanceId ElementId The id of the assembly instance to which the element belongs. (Inherited from Element .) Element
P BoundingBox BoundingBoxXYZ Retrieves a box that circumscribes all geometry of the element. (Inherited from Element .) Element
P Category Category Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element .) Element
P CreatedPhaseId ElementId Id of a Phase at which the Element was created. (Inherited from Element .) Element
P DemolishedPhaseId ElementId Id of a Phase at which the Element was demolished. (Inherited from Element .) Element
P DesignOption DesignOption Returns the design option to which the element belongs. (Inherited from Element .) Element
P DistributionType DistributionType The type of rebar distribution(also known as Rebar Set Type).
P Document Document Returns the Document in which the Element resides. (Inherited from Element .) Element
P Geometry GeometryElement Retrieves the geometric representation of the element. (Inherited from Element .) Element
P GroupId ElementId The id of the group to which an element belongs. (Inherited from Element .) Element
P Id ElementId A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element .) Element
P IncludeFirstBar bool Identifies if the first bar in rebar set is shown.
P IncludeLastBar bool Identifies if the last bar in rebar set is shown.
P IsTransient bool Indicates whether an element is transient or permanent. (Inherited from Element .) Element
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element .) Element
P LayoutRule RebarLayoutRule Identifies the layout rule of rebar set.
P LevelId ElementId The id of the level associated with the element. (Inherited from Element .) Element
P Location Location This property is used to find the physical location of an element within a project. (Inherited from Element .) Element
P MaxSpacing double Identifies the maximum spacing between rebar in rebar set.
P Name string A human readable name for the Element. (Inherited from Element .) Element
P NumberOfBarPositions int The number of potential bars in the set.
P OwnerViewId ElementId The id of the view that owns the element. (Inherited from Element .) Element
P Parameter.Guid. Parameter Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element .) Element
P Parameter.BuiltInParameter. Parameter Retrieves a parameter from the element given a parameter id. (Inherited from Element .) Element
P Parameter.Definition. Parameter Retrieves a parameter from the element based on its definition. (Inherited from Element .) Element
P Parameters ParameterSet Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element .) Element
P ParametersMap ParameterMap Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element .) Element
P Pinned bool Identifies if the element has been pinned to prevent changes. (Inherited from Element .) Element
P Quantity int Identifies the number of bars in rebar set.
P ReadOnlyParameters bool When set to true, Rebar will report all its parameters as read only. For example, the method Parameter::IsReadOnly() for all Rebar Parameters will return true. When set to false, the return value of Parameter::IsReadOnly() will not be affected.
P ScheduleMark string The Schedule Mark parameter. On creation, the Schedule Mark is set to a value that is unique to the host, but it can be set to any value.
P TotalLength double The length of an individual bar multiplied by Quantity.
P UniqueId string A stable unique identifier for an element within the document. (Inherited from Element .) Element
P VersionGuid Guid Get the element version Guid. (Inherited from Element .) Element
P ViewSpecific bool Identifies if the element is owned by a view. (Inherited from Element .) Element
P Volume double The volume of an individual bar multiplied by Quantity.
P WorksetId WorksetId Get Id of the Workset which owns the element. (Inherited from Element .) Element