AssemblyInstance
Description:
Combines multiple elements for tagging, filtering, scheduling and creating isolated assembly views.
Combines multiple elements for tagging, filtering, scheduling and creating isolated assembly views.
public class AssemblyInstance : Element
// Create assembly instance, name the assembly, and create views of the assembly
AssemblyInstance CreateAssemblyAndViews(Autodesk.Revit.DB.Document doc, ICollection<ElementId> elementIds)
{
AssemblyInstance assemblyInstance = null;
using (Transaction transaction = new Transaction(doc))
{
ElementId categoryId = doc.GetElement(elementIds.First()).Category.Id; // use category of one of the assembly elements
if (AssemblyInstance.IsValidNamingCategory(doc, categoryId, elementIds))
{
transaction.Start("Create Assembly Instance");
assemblyInstance = AssemblyInstance.Create(doc, elementIds, categoryId);
transaction.Commit(); // commit the transaction that creates the assembly instance before modifying the instance's name
if (transaction.GetStatus() == TransactionStatus.Committed)
{
transaction.Start("Set Assembly Name");
assemblyInstance.AssemblyTypeName = "My Assembly Name";
transaction.Commit();
}
if (assemblyInstance.AllowsAssemblyViewCreation()) // create assembly views for this assembly instance
{
if (transaction.GetStatus() == TransactionStatus.Committed)
{
transaction.Start("View Creation");
View3D view3d = AssemblyViewUtils.Create3DOrthographic(doc, assemblyInstance.Id);
ViewSchedule partList = AssemblyViewUtils.CreatePartList(doc, assemblyInstance.Id);
transaction.Commit();
}
}
}
}
return assemblyInstance;
}
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| AddMemberIds(ICollection<ElementId>) | None | Adds member element ids for the assembly instance. | |
| AllowsAssemblyViewCreation() | Boolean | Returns true if assembly views can be created for this Assembly Instance. | |
| AreElementsValidForAssembly(Document, ICollection<ElementId>, ElementId) | Boolean | Identifies if provided assembly members are valid. | |
| ArePhasesModifiable() | Boolean | Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element ) | Element |
| CanBeHidden(View) | Boolean | Indicates if the element can be hidden in the view. (Inherited from Element ) | Element |
| CanBeLocked() | Boolean | Identifies if the element can be locked. (Inherited from Element ) | Element |
| CanDeleteSubelement(Subelement) | Boolean | Checks if given subelement can be removed from the element. (Inherited from Element ) | Element |
| CanHaveTypeAssigned() | Boolean | Identifies if the element can have a type assigned. (Inherited from Element ) | Element |
| CanRemoveElementsFromAssembly(AssemblyInstance, ICollection<ElementId>) | Boolean | Identifies if provided assembly members can be removed from the assembly instance. | |
| ChangeTypeId(ElementId) | ElementId | Changes the type of the element. (Inherited from Element ) | Element |
| CompareAssemblyInstances(AssemblyInstance, AssemblyInstance) | AssemblyDifference | Compares two assembly instances and returns a result with details about the differences | |
| Create(Document, ICollection<ElementId>, ElementId) | AssemblyInstance | Creates a new assembly instance. | |
| DeleteEntity(Schema) | Boolean | Deletes the existing entity created by %schema% in the element (Inherited from Element ) | Element |
| DeleteSubelement(Subelement) | Boolean | Removes a subelement from the element. (Inherited from Element ) | Element |
| DeleteSubelements(IList<Subelement>) | Boolean | Removes the subelements from the element. (Inherited from Element ) | Element |
| Disassemble() | ICollection<ElementId> | Removes the assembly instance and releases the member elements. | |
| Dispose() | None | (Inherited from Element ) | Element |
| Equals | None | Determines whether the specified object is equal to the current object. (Inherited from Object ) | Object |
| EvaluateAllParameterValues() | IList<EvaluatedParameter> | Evaluates all the parameters' values of the element. (Inherited from Element ) | Element |
| EvaluateParameterValues(ISet<ElementId>) | IList<EvaluatedParameter> | Evaluate the parameters' values of the element on the given parameter ID set. (Inherited from Element ) | Element |
| GetCenter() | XYZ | Returns the center of the bounding box for the assembly instance. This is the default position for placed assembly instances. | |
| GetDependentElements(ElementFilter) | IList<ElementId> | Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element ) | Element |
| 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 |
| GetEntitySchemaGuids() | IList<Guid> | Returns the Schema guids of any Entities stored in this element. (Inherited from Element ) | Element |
| GetExternalFileReference() | ExternalFileReference | Gets information pertaining to the external file referenced by the element. (Inherited from Element ) | Element |
| GetExternalResourceReference(ExternalResourceType) | ExternalResourceReference | Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) | Element |
| GetExternalResourceReferenceExpanded(ExternalResourceType) | IList<ExternalResourceReference> | Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) | Element |
| GetExternalResourceReferences() | IDictionary<ExternalResourceType,ExternalResourceReference> | Gets the map of the external resource references referenced by the element. (Inherited from Element ) | Element |
| GetExternalResourceReferencesExpanded() | ExternalResourceType | Gets the expanded map of the external resource references referenced by the element. (Inherited from Element ) | Element |
| GetGeneratingElementIds(GeometryObject) | ICollection<ElementId> | Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element ) | Element |
| GetGeometryObjectFromReference(Reference) | GeometryObject | Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element ) | Element |
| GetHashCode | None | Serves as the default hash function. (Inherited from Object ) | Object |
| GetMaterialArea(ElementId, Boolean) | Double | Gets the area of the material with the given id. (Inherited from Element ) | Element |
| GetMaterialIds(Boolean) | ICollection<ElementId> | Gets the element ids of all materials present in the element. (Inherited from Element ) | Element |
| GetMaterialVolume(ElementId) | Double | Gets the volume of the material with the given id. (Inherited from Element ) | Element |
| GetMemberIds() | ICollection<ElementId> | Gets member element ids for the assembly instance. | |
| GetMonitoredLinkElementIds() | IList<ElementId> | Provides the link instance IDs when the element is monitoring. (Inherited from Element ) | Element |
| GetMonitoredLocalElementIds() | IList<ElementId> | Provides the local element IDs when the element is monitoring. (Inherited from Element ) | Element |
| GetOrderedParameters() | IList<Parameter> | Gets the parameters associated to the element in order. (Inherited from Element ) | Element |
| GetParameter(ForgeTypeId) | Parameter | Retrieves a parameter from the element given identifier. (Inherited from Element ) | Element |
| GetParameterFormatOptions(ElementId) | FormatOptions | Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element ) | Element |
| GetParameters(String) | IList<Parameter> | Retrieves the parameters from the element via the given name. (Inherited from Element ) | Element |
| GetPhaseStatus(ElementId) | ElementOnPhaseStatus | Gets the status of a given element in the input phase (Inherited from Element ) | Element |
| GetSubelements() | IList<Subelement> | Returns the collection of element subelements. (Inherited from Element ) | Element |
| GetTransform() | Transform | Gets the origin of the assembly instance. | |
| GetType | None | Gets the Type of the current instance. (Inherited from Object ) | Object |
| GetTypeId() | ElementId | Returns the identifier of this element's type. (Inherited from Element ) | Element |
| GetValidTypes() | ICollection<ElementId> | Obtains a set of types that are valid for this element. (Inherited from Element ) | Element |
| HasPhases() | Boolean | Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element ) | Element |
| IsCreatedPhaseOrderValid(ElementId) | Boolean | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) | Element |
| IsDemolishedPhaseOrderValid(ElementId) | Boolean | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) | Element |
| IsExternalFileReference() | Boolean | Determines whether this Element represents an external file. (Inherited from Element ) | Element |
| IsHidden(View) | Boolean | Identifies if the element has been permanently hidden in the view. (Inherited from Element ) | Element |
| IsMember(ElementId) | Boolean | Determines whether the given ElementId is a member of this assembly | |
| IsMonitoringLinkElement() | Boolean | Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element ) | Element |
| IsMonitoringLocalElement() | Boolean | Indicate whether an element is monitoring other local elements. (Inherited from Element ) | Element |
| IsPhaseCreatedValid(ElementId) | Boolean | Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element ) | Element |
| IsPhaseDemolishedValid(ElementId) | Boolean | Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element ) | Element |
| IsValidNamingCategory(Document, ElementId, ICollection<ElementId>) | Boolean | Identifies if the naming category is valid for an assembly instance. | |
| IsValidType(ElementId) | Boolean | Checks if given type is valid for this element. (Inherited from Element ) | Element |
| LookupParameter(String) | Parameter | Attempts to find a parameter on the element which has the given name. (Inherited from Element ) | Element |
| PlaceInstance(Document, ElementId, XYZ) | AssemblyInstance | Places an assembly instance of a given assembly type at the specified location. | |
| RefersToExternalResourceReference(ExternalResourceType) | Boolean | Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element ) | Element |
| RefersToExternalResourceReferences() | Boolean | Determines whether this Element uses external resources. (Inherited from Element ) | Element |
| RemoveMemberIds(ICollection<ElementId>) | None | Removes member element ids from the assembly instance. | |
| 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 |
| SetMemberIds(ICollection<ElementId>) | None | Sets member element ids for the assembly instance. All existing members are cleared. | |
| SetTransform(Transform) | None | Sets the origin of the assembly instance. | |
| ToString | None | Returns a string that represents the current object. (Inherited from Object ) | Object |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| AssemblyInstanceId | ElementId | The id of the assembly instance to which the element belongs. (Inherited from Element ) | Element |
| AssemblyTypeName | string | The name for the assembly type. All matching assembly instances share this name. Unique assembly instances are named automatically based on their naming category. | |
| BoundingBox | BoundingBoxXYZ | Retrieves a box that circumscribes all geometry of the element. (Inherited from Element ) | Element |
| Category | Category | Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element ) | Element |
| CreatedPhaseId | ElementId | Id of a Phase at which the Element was created. (Inherited from Element ) | Element |
| DemolishedPhaseId | ElementId | Id of a Phase at which the Element was demolished. (Inherited from Element ) | Element |
| DesignOption | DesignOption | Returns the design option to which the element belongs. (Inherited from Element ) | Element |
| Document | Document | Returns the Document in which the Element resides. (Inherited from Element ) | Element |
| Geometry | GeometryElement | Retrieves the geometric representation of the element. (Inherited from Element ) | Element |
| GroupId | ElementId | The id of the group to which an element belongs. (Inherited from Element ) | Element |
| Id | ElementId | A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element ) | Element |
| IsModifiable | bool | Identifies if the element is modifiable. (Inherited from Element ) | Element |
| IsTransient | bool | Indicates whether an element is transient or permanent. (Inherited from Element ) | Element |
| IsValidObject | Boolean | Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element ) | Element |
| LevelId | ElementId | The id of the level associated with the element. (Inherited from Element ) | Element |
| Location | Location | This property is used to find the physical location of the assembly instance within project. (Overrides Element . Location ) | |
| Name | string | A human readable name for the Element. (Inherited from Element ) | Element |
| NamingCategoryId | ElementId | Id of the category that drives the default naming scheme for the assembly instance. | |
| OwnerViewId | ElementId | The id of the view that owns the element. (Inherited from Element ) | Element |
| Parameter[BuiltInParameter] | Parameter | Retrieves a parameter from the element given a parameter id. (Inherited from Element ) | Element |
| Parameter[Definition] | Parameter | Retrieves a parameter from the element based on its definition. (Inherited from Element ) | Element |
| Parameter[Guid] | Parameter | Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element ) | Element |
| Parameters | ParameterSet | Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element ) | Element |
| ParametersMap | ParameterMap | Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element ) | Element |
| Pinned | bool | Identifies if the element has been pinned to prevent changes. (Inherited from Element ) | Element |
| UniqueId | string | A stable unique identifier for an element within the document. (Inherited from Element ) | Element |
| VersionGuid | Guid | Get the element version Guid. (Inherited from Element ) | Element |
| ViewSpecific | bool | Identifies if the element is owned by a view. (Inherited from Element ) | Element |
| WorksetId | WorksetId | Get Id of the Workset which owns the element. (Inherited from Element ) | Element |