M

TransmissionData.SetDesiredReferenceData

Description:
Sets the ExternalFileReference information which Revit should use the next time it opens the document which this TransmissionData belongs to.

Remarks:
There must already be a reference associated with the given id for this function to be valid. New references cannot be created in a closed file. See the documentation for a particular reference type to see its creation API.

public void SetDesiredReferenceData(
	ElementId elemId,
	ModelPath path,
	PathType pathType,
	bool shouldLoad
)

Public Sub SetDesiredReferenceData ( _
	elemId As ElementId, _
	path As ModelPath, _
	pathType As PathType, _
	shouldLoad As Boolean _
)

public:
void SetDesiredReferenceData(
	ElementId^ elemId, 
	ModelPath^ path, 
	PathType pathType, 
	bool shouldLoad
)

Autodesk.Revit.DB.ElementId

elemId

The id of the element associated with this reference.
Autodesk.Revit.DB.ModelPath

path

A ModelPath indicating the location to load the external file reference from.
Autodesk.Revit.DB.PathType

pathType

A PathType value indicating what type of path the ModelPath is.
Boolean

shouldLoad

True if the external file should be loaded the next time Revit opens the document. False if it should be unloaded.

Autodesk.Revit.Exceptions.ArgumentException

elemId does not correspond to an ExternalFileReference contained in this TransmissionData. -or- These inputs will not produce a valid ExternalFileReference.
Autodesk.Revit.Exceptions.ArgumentNullException

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

A value passed for an enumeration argument is not a member of that enumeration