ComponentRepeater Class

An element that contains and manages a set of repeated components.

Inheritance Hierarchy

SystemObject
Autodesk.Revit.DBElement
Autodesk.Revit.DBComponentRepeater

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

C++

Copy

public class ComponentRepeater : Element, 
	IEnumerable<ComponentRepeaterSlot>

Public Class ComponentRepeater
	Inherits Element
	Implements IEnumerable(Of ComponentRepeaterSlot)

public ref class ComponentRepeater : public Element, 
	IEnumerable<ComponentRepeaterSlot^>

type ComponentRepeater = 
    class
        inherit Element
        interface IEnumerable<ComponentRepeaterSlot>
    end

The ComponentRepeater type exposes the following members.

Properties

	Name	Description
	AssemblyInstanceId	The id of the assembly instance to which the element belongs. (Inherited from Element)
	BoundingBox	Retrieves a box that circumscribes all geometry of the element. (Inherited from Element)
	Category	Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element)
	CreatedPhaseId	Id of a Phase at which the Element was created. (Inherited from Element)
	DefaultFamilyType	The default family type for the component repeater.
	DemolishedPhaseId	Id of a Phase at which the Element was demolished. (Inherited from Element)
	DesignOption	Returns the design option to which the element belongs. (Inherited from Element)
	DimensionCount	The dimension count of the component repeater.
	Document	Returns the Document in which the Element resides. (Inherited from Element)
	Geometry	Retrieves the geometric representation of the element. (Inherited from Element)
	GroupId	The id of the group to which an element belongs. (Inherited from Element)
	Id	A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element)
	IsModifiable	Identifies if the element is modifiable. (Inherited from Element)
	IsTransient	Indicates whether an element is transient or permanent. (Inherited from Element)
	IsValidObject	Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element)
	LevelId	The id of the level associated with the element. (Inherited from Element)
	Location	This property is used to find the physical location of an element within a project. (Inherited from Element)
	Name	A human readable name for the Element. (Inherited from Element)
	OwnerViewId	The id of the view that owns the element. (Inherited from Element)
	ParameterBuiltInParameter	Retrieves a parameter from the element given a parameter id. (Inherited from Element)
	ParameterDefinition	Retrieves a parameter from the element based on its definition. (Inherited from Element)
	ParameterGuid	Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element)
	Parameters	Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element)
	ParametersMap	Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element)
	Pinned	Identifies if the element has been pinned to prevent changes. (Inherited from Element)
	UniqueId	A stable unique identifier for an element within the document. (Inherited from Element)
	VersionGuid	Get the element version Guid. (Inherited from Element)
	ViewSpecific	Identifies if the element is owned by a view. (Inherited from Element)
	WorksetId	Get Id of the Workset which owns the element. (Inherited from Element)

Top

Methods

	Name	Description
	ArePhasesModifiable	Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element)
	CanBeHidden	Indicates if the element can be hidden in the view. (Inherited from Element)
	CanBeLocked	Identifies if the element can be locked. (Inherited from Element)
	CanDeleteSubelement	Checks if given subelement can be removed from the element. (Inherited from Element)
	CanElementBeRepeated	Determines whether an element can be repeated using the RepeatElements method.
	CanHaveTypeAssigned	Identifies if the element can have a type assigned. (Inherited from Element)
	ChangeTypeId(ElementId)	Changes the type of the element. (Inherited from Element)
	DeleteEntity	Deletes the existing entity created by %schema% in the element (Inherited from Element)
	DeleteSubelement	Removes a subelement from the element. (Inherited from Element)
	DeleteSubelements	Removes the subelements from the element. (Inherited from Element)
	Dispose	(Inherited from Element)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	EvaluateAllParameterValues	Evaluates all the parameters' values of the element. (Inherited from Element)
	EvaluateParameterValues	Evaluate the parameters' values of the element on the given parameter ID set. (Inherited from Element)
	GetBasicIEnumerator	Returns an enumerator that iterates through a collection.
	GetDependentElements	Get all elements that, from a logical point of view, are the children of this Element. (Inherited from 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)
	GetEntitySchemaGuids	Returns the Schema guids of any Entities stored in this element. (Inherited from Element)
	GetEnumerator	Returns an enumerator that iterates through a collection.
	GetExternalFileReference	Gets information pertaining to the external file referenced by the element. (Inherited from Element)
	GetExternalResourceReference	Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element)
	GetExternalResourceReferenceExpanded	Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element)
	GetExternalResourceReferences	Gets the map of the external resource references referenced by the element. (Inherited from Element)
	GetExternalResourceReferencesExpanded	Gets the expanded map of the external resource references referenced by the element. (Inherited from Element)
	GetGeneratingElementIds	Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element)
	GetGeometryObjectFromReference	Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetMaterialArea	Gets the area of the material with the given id. (Inherited from Element)
	GetMaterialIds	Gets the element ids of all materials present in the element. (Inherited from Element)
	GetMaterialVolume	Gets the volume of the material with the given id. (Inherited from Element)
	GetMonitoredLinkElementIds	Provides the link instance IDs when the element is monitoring. (Inherited from Element)
	GetMonitoredLocalElementIds	Provides the local element IDs when the element is monitoring. (Inherited from Element)
	GetOrderedParameters	Gets the parameters associated to the element in order. (Inherited from Element)
	GetParameter	Retrieves a parameter from the element given identifier. (Inherited from Element)
	GetParameterFormatOptions	Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element)
	GetParameters	Retrieves the parameters from the element via the given name. (Inherited from Element)
	GetPhaseStatus	Gets the status of a given element in the input phase (Inherited from Element)
	GetSubelements	Returns the collection of element subelements. (Inherited from Element)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	GetTypeId	Returns the identifier of this element's type. (Inherited from Element)
	GetValidTypes	Obtains a set of types that are valid for this element. (Inherited from Element)
	HasPhases	Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element)
	IsCreatedPhaseOrderValid	Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element)
	IsDemolishedPhaseOrderValid	Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element)
	IsExternalFileReference	Determines whether this Element represents an external file. (Inherited from Element)
	IsHidden	Identifies if the element has been permanently hidden in the view. (Inherited from Element)
	IsMonitoringLinkElement	Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element)
	IsMonitoringLocalElement	Indicate whether an element is monitoring other local elements. (Inherited from Element)
	IsPhaseCreatedValid	Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element)
	IsPhaseDemolishedValid	Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element)
	IsTypeValidForRepeater	Determines whether given family type can be used as the default type for the repeater.
	IsValidType(ElementId)	Checks if given type is valid for this element. (Inherited from Element)
	LookupParameter	Attempts to find a parameter on the element which has the given name. (Inherited from Element)
	RefersToExternalResourceReference	Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element)
	RefersToExternalResourceReferences	Determines whether this Element uses external resources. (Inherited from Element)
	RemoveRepeaters	Removes component repeaters from the document, but leaves the individual repeated components in their respective locations and hosted on their original hosts.
	RepeatElements	Repeats a set of adaptive component hosted on one or more repeating references.
	SetEntity	Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. (Inherited from Element)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Remarks

Component repeaters can be used to replicate (repeat) elements hosted on repeating references. The result of the repeating operation is a collection of slots. Each slot contains one repeated component. The ComponentRepeater class provides the repeating functionality and access to the slots.

Each repeating reference is capable of hosting one point of an adaptive component. An initial pattern can be created by populating one or more repeating references with such points. Component repeaters can then be used to replicate the pattern to fill the rest of the repeating references in the particular repeating reference source.

The repeating references in repeating reference source are arranged in one or two dimensional arrays, allowing for different kinds of repeating:

One dimensional source allows for repeating along a path.
Two dimensional source allows for repeating across a grid.
It is also possible to host a point on a zero dimensional reference (a point). This point will be shared by all slots. A zero dimensional source allows for repeating around a single point. It should not be used alone, but together with at least one other repeating reference source (typically one dimensional.) The point hosted on the zero dimensional source serves as a central point around which other points can be repeated on their respective repeating reference sources.

Multiple adaptive components may be hosted on one repeating reference source, and different points of one adaptive component may be hosted on different repeating reference sources, effectively allowing different points of an adaptive component to be repeated using different patterns.

Following is a typical component repeater creation workflow:

Get the default repeating reference source from a point element, divided path or divided surface. (See HasRepeatingReferenceSource(Document, ElementId) and GetDefaultRepeatingReferenceSource(Document, ElementId).)
Query the bounds of the repeating reference source to find a range of valid coordinates. (See DimensionCount and GetBounds.)
Create one or more instances of adaptive families that will be repeated.
Host the individual points of an adaptive component on one or more repeating references. (See GetReference(RepeaterCoordinates).)
Repeat the set of adaptive components using the RepeatElements() method.

Component repeaters can only be used in Massing families (the conceptual design environment).

Reference

Autodesk.Revit.DB Namespace