ExternalResourceReference Members

The ExternalResourceReference type exposes the following members.


Name Description
Public method ExternalResourceReference(ExternalResourceReference)
Creates a new ExternalResourceReference from the given ExternalResourceReference.
Public method ExternalResourceReference(Guid, IDictionary String, String , String, String)
Creates a new ExternalResourceReference from the given data.


Name Description
Public method Static member CreateLocalResource
Creates an ExternalResourceReference representing a local file managed by Revit's built-in server.
Public method Dispose
Releases all resources used by the ExternalResourceReference
Public method Equals
Determines whether the specified Object is equal to the current Object .
(Inherited from Object .)
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object .)
Public method GetReferenceInformation
Returns a copy of an object containing previously-stored reference or lookup information about the specific resource provided by the server.
Public method GetResourceShortDisplayName
Gets the short display name of the external resource.
Public method GetResourceVersionStatus
Checks whether this ExternalResourceReference corresponds to the current version of the resource.
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Public method HasValidDisplayPath
Checks whether this external Resource has a valid display path.
Public method IsValidReference
Checks whether the reference is in a valid format.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)


Name Description
Public property InSessionPath

The path stores the full display path which includes the server name plus the path provided by ExternalResourceServer.

The path that Revit will present for user recognizing and browsing to this resource during one session of Revit.

This property allows ExternalResourceServers to handle cases where the path to a resource may vary between Revit sessions. For example, if this ExternalResourceReference refers to a resource in a folder, this property can be used to store the current path of the resource. If the resource is moved to another folder later, the ExternalResourceServer could calculate the correct path for the resource from resource identification information when it is loaded and store it in this property, so that it will work correctly even if the rvt file is opened in a different location.

Do not rely on this path to look up an ExternalResourceReference, as the path is neither unique nor stable. It isn't unique because multiple servers might use the same server name and display name format. It isn't stable because some servers allow renaming, and because a server might change its name at some point.

Public property IsValidObject
Specifies whether the .NET object represents a valid Revit entity.
Public property ServerId
The id of the server that Revit is expecting to provide the external resource.
Public property Version
The version of the external data that was most recently loaded in Revit.

See Also