GetTopLevelLink Method (Document, ModelPath)


Returns the ElementId of the (top-level) linked model with the given path.

Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 22.0.0.0 (22.1.0.0)
Since: 2013

Syntax

C#
public static ElementId GetTopLevelLink(
	Document document,
	ModelPath path
)
Visual Basic
Public Shared Function GetTopLevelLink ( _
	document As Document, _
	path As ModelPath _
) As ElementId
Visual C++
public:
static ElementId^ GetTopLevelLink(
	Document^ document, 
	ModelPath^ path
)

Parameters

document
Type: Autodesk.Revit.DB Document
The document to look for the linked model in.
path
Type: Autodesk.Revit.DB ModelPath
A path indicating which linked model to return.

Return Value

The id of the link with the given path, or InvalidElementId if there is no top-level link at that path.

Remarks

This function will not return nested links.

Exceptions

Exception Condition
Autodesk.Revit.Exceptions ArgumentNullException A non-optional argument was null

See Also

ArchiLabs Desktop

Put AI to work inside Revit.

Give Desktop your instructions and project files to build Revit families, update model elements, and create views and schedules. Works directly in Revit and AutoCAD.

Explore Desktop →