M

Document.Link

Description:
Links an OBJ file into the project document.

Remarks:
Link isn't supported for family documents. Please use import instead.

Overloads (8):

Link(String,DGNImportOptions,View,ElementId)

Link(String,DWFImportOptions)

Link(String,DWGImportOptions,View,ElementId)

Link(String,ImportOptions3DM,View)

Link(String,OBJImportOptions,View)

Link(String,SATImportOptions,View)

Link(String,SKPImportOptions,View)

Link(String,STLImportOptions,View)

public ElementId Link(
	string file,
	OBJImportOptions options,
	View pDBView
)

Public Function Link ( _
	file As String, _
	options As OBJImportOptions, _
	pDBView As View _
) As ElementId

public:
ElementId^ Link(
	String^ file, 
	OBJImportOptions^ options, 
	View^ pDBView
)

String

file

Full path of the file to link. File must exist and must be a valid OBJ file.
Autodesk.Revit.DB.OBJImportOptions

options

Various import options applicable to the OBJ format. If nulla null reference (Nothing in Visual Basic), all options will be set to their respective default values.
Autodesk.Revit.DB.View

pDBView

View used to aid placement of the linked file. If the options specify ThisViewOnly, this argument is required and the linked file will only be visible in the specified view. If the options specify center-to-center placement, this argument is required and the linked file will be placed in the center of the specified view. Otherwise, this view is used to obtain a base level to associate with the linked file. If not specified, an existing view will be chosen instead and may open a view or associate the linked file to an arbitrary level.

Return Value ElementId Returns the element Id of the linked instance.

Autodesk.Revit.Exceptions.ArgumentException

Not a valid file for OBJ import (.obj files are valid). -or- ThisViewOnly cannot be true when importing a DWG|DGN drawing into a 3D view. -or- The provided view is not valid for the options provided. -or- One or more strings describing layer selection is invalid or empty. -or- The scale is not valid as a CustomScale for use during import. -or- NullOrEmpty -or- The view is not printable.
Autodesk.Revit.Exceptions.ArgumentNullException

A non-optional argument was null
Autodesk.Revit.Exceptions.FileArgumentNotFoundException

The given file does not exist.
Autodesk.Revit.Exceptions.InvalidOperationException

Import is temporarily disabled. -or- This Document is not a project document.
Autodesk.Revit.Exceptions.ModificationForbiddenException

The document is in failure mode: an operation has failed, and Revit requires the user to either cancel the operation or fix the problem (usually by deleting certain elements). -or- The document is being loaded, or is in the midst of another sensitive process.
Autodesk.Revit.Exceptions.ModificationOutsideTransactionException

The document has no open transaction.
Autodesk.Revit.Exceptions.OptionalFunctionalityNotAvailableException

The OBJ Import/Link module is not available in the installed Revit.