2023 Class
Changes 0
C

LinkLoadContent

Description:
This class is used by IExternalResourceServers to return Link data to Revit when their LoadResource method is invoked. It also contains additional information used by IExternalResourceUIServers to display link load status results to the user.
Remarks:

This class handles Revit links.

Revit links must be loaded from a path accessible to Revit. Server implementors should provide Revit with a ModelPath representing a location from which to load the link. Revit will handle the actual file loading.

Servers which represent non-local file locations will need to create their own implementation for copying or moving files to a Revit-accessible location.

The link data path used for link loading may be different from the path displayed to the user. The link data path represents the literal location of the file, whereas the link's display path represents what the user sees as the name of the link. See [!:Autodesk::Revit::DB::ExternalResourceReference::InSessionPath] for more details on display paths.

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.ExternalResourceLoadContent
    Autodesk.Revit.DB.LinkLoadContent
Name Return Type Description Inherited From
M GetLinkDataPath() ModelPath Returns the Link data path owned by this LinkLoadContent object.
M GetLinkLoadResult() LinkLoadResult Retrieves the LinkLoadResult of the attempt to load or reload a Revit link.
M SetLinkDataPath(ModelPath) None Sets the Link data path owned by this LinkLoadContent object.
M Dispose() None Releases all resources used by the ExternalResourceLoadContent
Name Return Type Description Inherited From
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity. ExternalResourceLoadContent
P LoadStatus ExternalResourceLoadStatus A value to indicate the status of an external resource load operation. IExternalResourceServers should set this in the LoadResource() method. ExternalResourceLoadContent
P Version string The version of the external data that the server is providing in this object. ExternalResourceLoadContent