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
// Identify the difference, if any, between two assembly instances
void FindAssemblyDifferences(AssemblyInstance instance1, AssemblyInstance instance2)
{
Autodesk.Revit.DB.Document doc = instance1.Document;
AssemblyDifference difference = AssemblyInstance.CompareAssemblyInstances(instance1, instance2);
AssemblyDifferenceNone diffNone = difference as AssemblyDifferenceNone;
if (diffNone != null)
{
TaskDialog.Show("Revit", "Assemblies are identical");
return;
}
AssemblyDifferenceConfiguration diffConfig = difference as AssemblyDifferenceConfiguration;
if (diffConfig != null)
{
TaskDialog.Show("Revit", "Elements are not arranged in space relative to each other in the same way");
return;
}
AssemblyDifferenceMemberCount diffMemberCount = difference as AssemblyDifferenceMemberCount;
if (diffMemberCount != null)
{
TaskDialog.Show("Revit", "Elements counts differ: " + diffMemberCount.Count1 + " & " + diffMemberCount.Count2);
return;
}
AssemblyDifferenceNamingCategory diffNameCat = difference as AssemblyDifferenceNamingCategory;
if (diffNameCat != null)
{
int catInt1 = diffNameCat.NamingCategoryId1.IntegerValue;
int catInt2 = diffNameCat.NamingCategoryId2.IntegerValue;
TaskDialog.Show("Revit", "Naming categories differ: " +
doc.Settings.Categories.get_Item((BuiltInCategory)catInt1).Name + " & " +
doc.Settings.Categories.get_Item((BuiltInCategory)catInt2).Name);
return;
}
AssemblyDifferenceMemberDifference memberDifference = difference as AssemblyDifferenceMemberDifference;
if (memberDifference != null)
{
AssemblyMemberDifference assemblyMemberDifference = memberDifference.MemberDifference as AssemblyMemberDifference;
AssemblyMemberDifferentCategory differentCategory = assemblyMemberDifference as AssemblyMemberDifferentCategory;
if (differentCategory != null)
{
int int1 = differentCategory.CategoryId1.IntegerValue;
int int2 = differentCategory.CategoryId2.IntegerValue;
TaskDialog.Show("Revit", "Element categories differ: " +
doc.Settings.Categories.get_Item((BuiltInCategory)int1).Name + " & " +
doc.Settings.Categories.get_Item((BuiltInCategory)int2).Name);
return;
}
AssemblyMemberDifferentGeometry differentGeometry = assemblyMemberDifference as AssemblyMemberDifferentGeometry;
if (differentGeometry != null)
{
TaskDialog.Show("Revit", "Member geometry differs");
return;
}
AssemblyMemberDifferentParameters differentParameters = assemblyMemberDifference as AssemblyMemberDifferentParameters;
if (differentParameters != null)
{
TaskDialog.Show("Revit", "Member parameters differs");
return;
}
AssemblyMemberDifferentType differentType = assemblyMemberDifference as AssemblyMemberDifferentType;
if (differentType != null)
{
TaskDialog.Show("Revit", "Element types differ: " + doc.GetElement(differentType.TypeId1).Name + " & " + doc.GetElement(differentType.TypeId2).Name);
return;
}
}
return;
}
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| AddMemberIds(ICollection<ElementId>) | None | Adds member element ids for the assembly instance. | |
| AllowsAssemblyViewCreation() | bool | Returns true if assembly views can be created for this Assembly Instance. | |
| AreElementsValidForAssembly(Document, ICollection<ElementId>, ElementId) | bool | Identifies if provided assembly members are valid. | |
| CanRemoveElementsFromAssembly(AssemblyInstance, ICollection<ElementId>) | bool | Identifies if provided assembly members can be removed from the assembly instance. | |
| 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. | |
| Disassemble() | ICollection<ElementId> | Removes the assembly instance and releases the member elements. | |
| GetCenter() | XYZ | Returns the center of the bounding box for the assembly instance. This is the default position for placed assembly instances. | |
| GetMemberIds() | ICollection<ElementId> | Gets member element ids for the assembly instance. | |
| GetTransform() | Transform | Gets the origin of the assembly instance. | |
| IsMember(ElementId) | bool | Determines whether the given ElementId is a member of this assembly | |
| IsValidNamingCategory(Document, ElementId, ICollection<ElementId>) | bool | Identifies if the naming category is valid for an assembly instance. | |
| PlaceInstance(Document, ElementId, XYZ) | AssemblyInstance | Places an assembly instance of a given assembly type at the specified location. | |
| RemoveMemberIds(ICollection<ElementId>) | None | Removes member element ids from the assembly instance. | |
| 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. | |
| ArePhasesModifiable() | bool | Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. | Element |
| CanBeHidden(View) | bool | Indicates if the element can be hidden in the view. | Element |
| CanBeLocked() | bool | Identifies if the element can be locked. | Element |
| CanDeleteSubelement(Subelement) | bool | Checks if given subelement can be removed from the element. | Element |
| CanHaveAnalyticalModel() | bool | Indicates whether the Element can have an Analytical Model. | Element |
| CanHaveTypeAssigned() | bool | Identifies if the element can have a type assigned. | Element |
| CanHaveTypeAssigned(Document, ICollection<ElementId>) | bool | Checks if all elements in the set can have a type assigned. | Element |
| ChangeTypeId(Document, ICollection<ElementId>, ElementId) | IDictionary | Changes the type of all elements in the given set. | Element |
| ChangeTypeId(ElementId) | ElementId | Changes the type of the element. | Element |
| DeleteEntity(Schema) | bool | Deletes the existing entity created by %schema% in the element | Element |
| DeleteSubelement(Subelement) | bool | Removes a subelement from the element. | Element |
| DeleteSubelements(IList<Subelement>) | bool | Removes the subelements from the element. | Element |
| Dispose() | None | Releases all resources used by the | Element |
| GetAnalyticalModelId() | Element Id. | Retrieves the Element Id of the Analytical Model Element for this Element. | Element |
| GetAnalyticalModel() | Writeable Analytical Model. | Retrieves writeable Analytical Model for Element. | Element |
| GetChangeTypeAny() | ChangeType | Returns ChangeType associated with any change in an element. | Element |
| GetChangeTypeElementAddition() | ChangeType | Returns ChangeType associated with element addition | Element |
| GetChangeTypeElementDeletion() | ChangeType | Returns ChangeType associated with element deletion. | Element |
| GetChangeTypeGeometry() | ChangeType | Returns ChangeType associated with a change in the geometry of an element | Element |
| GetChangeTypeParameter(ElementId) | ChangeType | Returns ChangeType associated with a change in a parameter's value | Element |
| GetChangeTypeParameter(Parameter) | ChangeType | Returns ChangeType associated with a change in a parameter's value | Element |
| GetDependentElements(ElementFilter) | IList<ElementId> | Get all elements that, from a logical point of view, are the children of this Element. | Element |
| 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. | Element |
| GetEntitySchemaGuids() | IList<Guid> | Returns the Schema guids of any Entities stored in this element. | Element |
| GetExternalFileReference() | ExternalFileReference | Gets information pertaining to the external file referenced by the element. | Element |
| GetExternalResourceReference(ExternalResourceType) | ExternalResourceReference | Gets the ExternalResourceReference associated with a specified external resource type. | Element |
| GetExternalResourceReferences() | IDictionary | Gets the full map of the external resource references referenced by the element. | Element |
| GetGeneratingElementIds(GeometryObject) | ICollection<ElementId> | Returns the ids of the element(s) that generated the input geometry object. | Element |
| GetGeometryObjectFromReference(Reference) | GeometryObject | Retrieve one geometric primitive contained in the element given a reference. | Element |
| GetMaterialArea(ElementId, Boolean) | double | Gets the area of the material with the given id. | Element |
| GetMaterialIds(Boolean) | ICollection<ElementId> | Gets the element ids of all materials present in the element. | Element |
| GetMaterialVolume(ElementId) | double | Gets the volume of the material with the given id. | Element |
| GetMonitoredLinkElementIds() | IList<ElementId> | Provides the link instance IDs when the element is monitoring. | Element |
| GetMonitoredLocalElementIds() | IList<ElementId> | Provides the local element IDs when the element is monitoring. | Element |
| GetOrderedParameters() | IList<Parameter> | Gets the parameters associated to the element in order. | Element |
| GetParameterFormatOptions(ElementId) | FormatOptions | Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. | Element |
| GetParameter(ForgeTypeId) | Parameter | Retrieves a parameter from the element given identifier. | Element |
| GetParameters(String) | IList<Parameter> | Retrieves the parameters from the element via the given name. | Element |
| GetPhaseStatus(ElementId) | ElementOnPhaseStatus | Gets the status of a given element in the input phase | Element |
| GetSubelements() | IList<Subelement> | Returns the collection of element subelements. | Element |
| GetTypeId() | ElementId | Returns the identifier of this element's type. | Element |
| GetValidTypes() | ICollection<ElementId> | Obtains a set of types that are valid for this element. | Element |
| GetValidTypes(Document, ICollection<ElementId>) | ICollection<ElementId> | Obtains a set of types that are valid for all given elements. | Element |
| HasPhases() | bool | Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. | Element |
| IsCreatedPhaseOrderValid(ElementId) | bool | Returns true if createdPhaseId and demolishedPhaseId are in order. | Element |
| IsDemolishedPhaseOrderValid(ElementId) | bool | Returns true if createdPhaseId and demolishedPhaseId are in order. | Element |
| IsExternalFileReference() | bool | Determines whether this Element represents an external file. | Element |
| IsHidden(View) | bool | Identifies if the element has been permanently hidden in the view. | Element |
| IsMonitoringLinkElement() | bool | Indicate whether an element is monitoring any elements in any linked models. | Element |
| IsMonitoringLocalElement() | bool | Indicate whether an element is monitoring other local elements. | Element |
| IsPhaseCreatedValid(ElementId) | bool | Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. | Element |
| IsPhaseDemolishedValid(ElementId) | bool | Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. | Element |
| IsValidType(Document, ICollection<ElementId>, ElementId) | bool | Checks if given type is valid for the set of elements. | Element |
| IsValidType(ElementId) | bool | Checks if given type is valid for this element. | Element |
| LookupParameter(String) | nullNothingnullptr | Attempts to find a parameter on the element which has the given name. | Element |
| RefersToExternalResourceReference(ExternalResourceType) | bool | Determines whether this Element uses external resources associated with a specified external resource type. | Element |
| RefersToExternalResourceReferences() | bool | Determines whether this Element uses external resources. | Element |
| SetEntity(Entity) | None | Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. | Element |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| 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. | |
| Location | Location | This property is used to find the physical location of the assembly instance within project. | |
| NamingCategoryId | ElementId | Id of the category that drives the default naming scheme for the assembly instance. | |
| AssemblyInstanceId | ElementId | The id of the assembly instance to which the element belongs. | Element |
| BoundingBox | BoundingBoxXYZ | Retrieves a box that circumscribes all geometry of the element. | Element |
| Category | Category | Retrieves a Category object that represents the category or sub category in which the element resides. | Element |
| CreatedPhaseId | ElementId | Id of a Phase at which the Element was created. | Element |
| DemolishedPhaseId | ElementId | Id of a Phase at which the Element was demolished. | Element |
| DesignOption | DesignOption | Returns the design option to which the element belongs. | Element |
| Document | Document | Returns the Document in which the Element resides. | Element |
| Geometry | GeometryElement | Retrieves the geometric representation of the element. | Element |
| GroupId | ElementId | The id of the group to which an element belongs. | Element |
| Id | ElementId | A unique identifier for an Element in an Autodesk Revit project. | Element |
| IsTransient | bool | Indicates whether an element is transient or permanent. | Element |
| IsValidObject | bool | Specifies whether the .NET object represents a valid Revit entity. | Element |
| LevelId | ElementId | The id of the level associated with the element. | Element |
| Location | Location | This property is used to find the physical location of an element within a project. | Element |
| Name | string | A human readable name for the Element. | Element |
| OwnerViewId | ElementId | The id of the view that owns the element. | Element |
| Parameter | Parameter | Retrieves a parameter from the element given a parameter id. | Element |
| Parameter | Parameter | Retrieves a parameter from the element based on its definition. | Element |
| Parameter | Parameter | Retrieves a parameter from the element given a GUID for a shared parameter. | Element |
| ParametersMap | ParameterMap | Retrieves a map containing all of the parameters that are contained within the element. | Element |
| Parameters | ParameterSet | Retrieves a set containing all of the parameters that are contained within the element. | Element |
| Pinned | bool | Identifies if the element has been pinned to prevent changes. | Element |
| UniqueId | string | A stable unique identifier for an element within the document. | Element |
| VersionGuid | Guid | Get the element version Guid. | Element |
| ViewSpecific | bool | Identifies if the element is owned by a view. | Element |
| WorksetId | WorksetId | Get Id of the Workset which owns the element. | Element |