RevitLinkType
Description:
This class represents another Revit Document ("link") brought into the current one ("host").
This class represents another Revit Document ("link") brought into the current one ("host").
Remarks:
Revit links can be nested - There can exist linked files which themselves contain links. A "top-level" link is one linked directly into the host, while a "nested" link is linked into some parent link. This can go through arbitrarily many layers. Some functions give the example "A -> B -> C". This means that there is a host file, A, which has a top-level link, B, and a nested link C which has been linked into B as an attachment.
Revit links can be nested - There can exist linked files which themselves contain links. A "top-level" link is one linked directly into the host, while a "nested" link is linked into some parent link. This can go through arbitrarily many layers. Some functions give the example "A -> B -> C". This means that there is a host file, A, which has a top-level link, B, and a nested link C which has been linked into B as an attachment.
Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.ElementType
Autodesk.Revit.DB.RevitLinkType
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.ElementType
Autodesk.Revit.DB.RevitLinkType
public class RevitLinkType : ElementType| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| CreateFromIFC(Document, ExternalResourceReference, String, Boolean, RevitLinkOptions) | LinkLoadResult | Creates a new Revit link type from an existing Revit file created via import by reference of an asscoiated IFC file. | |
| CreateFromIFC(Document, String, String, Boolean, RevitLinkOptions) | LinkLoadResult | Creates a new Revit link type from an existing Revit file created via import by reference of an asscoiated IFC file. | |
| Create(Document, ExternalResourceReference, RevitLinkOptions) | LinkLoadResult | Creates a new Revit link type from an external resource reference and loads the linked document. | |
| Create(Document, ModelPath, RevitLinkOptions) | LinkLoadResult | Creates a new Revit link type and loads the linked document. | |
| GetChildIds() | ICollection<ElementId> | Gets the ids of the immediate children of this link. | |
| GetConversionData() | LinkConversionData | Returns the optional data that is necessary to generate the Revit file for this link. | |
| GetLinkedFileStatus() | LinkedFileStatus | Returns the LinkedFileStatus of this link. | |
| GetParentId() | ElementId | Gets the id of this link's immediate parent. | |
| GetPhaseMap() | IDictionary | Returns a mapping between phases in the host document and phases in the linked document. | |
| GetRootId() | ElementId | Gets the id of the top-level link which this link is linked into. | |
| GetTopLevelLink(Document, ExternalResourceReference) | ElementId | Returns the ElementId of the (top-level) linked model with the given ExternalResourceReference. | |
| GetTopLevelLink(Document, ModelPath) | ElementId | Returns the ElementId of the (top-level) linked model with the given path. | |
| HasSaveablePositions() | bool | Determines whether the link has changes to shared positioning that could be saved. | |
| IsFromLocalPath() | bool | Checks whether the Revit link uses a local path, such as a hard drive. | |
| IsFromRevitServer() | bool | Checks whether the Revit link is located on Revit Server. | |
| IsLoaded(Document, ElementId) | bool | Checks whether the link with this id is loaded. | |
| IsNotLoadedIntoMultipleOpenDocuments() | bool | Checks whether the link is loaded into more than one open document in this session of Revit. If the link is loaded into multiple open documents, reload will be disabled. | |
| LoadFrom(ExternalResourceReference, WorksetConfiguration) | LinkLoadResult | Loads or reloads the Revit link. The link will be loaded from the location given in the input ExternalResourceReference. | |
| LoadFrom(ModelPath, WorksetConfiguration) | LinkLoadResult | Loads or reloads the Revit link from disk or cloud. The link will be loaded from the input path. | |
| Load() | LinkLoadResult | Loads or reloads the Revit link from its currently-stored location. If the link is an external resource, Revit will contact the IExternalResourceServer to get the latest version of the link. | |
| Reload() | LinkLoadResult | Loads or reloads the Revit link from its currently-stored location. If the link is an external resource, Revit will contact the IExternalResourceServer to get the latest version of the link. | |
| RevertLocalUnloadStatus() | LinkedFileStatus | Restores the workshared load status of a link that has been unloaded only for the current user, in a local copy of a workshared model. | |
| SavePositions(ISaveSharedCoordinatesCallback) | bool | Saves shared coordinates changes back to the linked document. | |
| UnloadLocally(ISaveSharedCoordinatesCallbackForUnloadLocally) | bool | Unloads a Revit link for the current user only. | |
| Unload(ISaveSharedCoordinatesCallback) | None | Unloads the Revit link. | |
| UpdateFromIFC(Document, ExternalResourceReference, String, Boolean) | bool | Updates a Revit link type from an IFC file and loads the linked document. | |
| UpdateFromIFC(Document, String, String, Boolean) | bool | Updates a Revit link type from an IFC file and loads the linked document. | |
| 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 |
| 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 |
| EvaluateAllParameterValues() | EvaluatedParameter | Evaluates all the parameters' values of the element. | Element |
| EvaluateParameterValues(ISet<ElementId>) | EvaluatedParameter | Evaluate the parameters' values of the element on the given parameter ID set. | 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 |
| GetExternalResourceReferenceExpanded(ExternalResourceType) | IList<ExternalResourceReference> | Gets the collection of ExternalResourceReference associated with a specified external resource type. | Element |
| GetExternalResourceReference(ExternalResourceType) | ExternalResourceReference | Gets the ExternalResourceReference associated with a specified external resource type. | Element |
| GetExternalResourceReferencesExpanded() | IDictionary | Gets the expanded map of the external resource references referenced by the element. | Element |
| GetExternalResourceReferences() | IDictionary | Gets the 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 |
| Duplicate(String) | ElementType | Duplicates an existing element type and assigns it a new name. | ElementType |
| GetPreviewImage(Size) | nullNothingnullptr | Get the preview image of an element. This image is similar to what is seen in the Revit UI when selecting the type of an element. | ElementType |
| GetSimilarTypes() | ICollection<ElementId> | Obtains a set of types that are similar to this type. | ElementType |
| IsSimilarType(ElementId) | bool | Checks if given type is similar to this type. | ElementType |
| IsValidDefaultFamilyType(ElementId) | bool | Identifies if this type is a valid default family type for the given family category id. | ElementType |
| Name | Return Type | Description | Inherited From |
|---|---|---|---|
| AttachmentType | AttachmentType | The attachment/overlay status of this link. | |
| IsNestedLink | bool | Indicates whether this link is a nested or top-level link. | |
| LocallyUnloaded | bool | Checks whether a Revit link in a local model is unloaded only for the current user. | |
| PathType | PathType | The type of path the link uses. | |
| 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 |
| IsModifiable | bool | Identifies if the element is modifiable. | 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 |
| CanBeCopied | bool | Determine if this ElementType can create a copy | ElementType |
| CanBeDeleted | bool | Determine if this ElementType can be deleted | ElementType |
| CanBeRenamed | bool | Determine if this ElementType can be renamed | ElementType |
| FamilyName | string | Gets the family name of this element type. | ElementType |
| Name | string | Set the name for the ElementType. | ElementType |