ExternalFileReference

Public Class

A class that contains the details of a reference to a file outside of a given document.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.ExternalFileReference

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class ExternalFileReference : IDisposable

The ExternalFileReference type exposes the following members.

Properties

Name

Description

Public Property

ExternalFileReferenceType

The type of external file which this object references.

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

Public Property

PathType

The path type of the link (relative, absolute, or server).

Methods

Name

Description

Public Method

Dispose

Releases all resources used by the ExternalFileReference

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method
GetAbsolutePath

Returns an absolute path to the referenced file, regardless of whether the PathType.Enum is relative or absolute.

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method
GetLinkedFileStatus

Returns a LinkedFileStatus.Enum corresponding to the load status of the referenced file.

Public Method

GetPath

Gets the path of the link, relative or absolute according to the link’s settings

Public Method

GetReferencingId

Gets the ElementId corresponding to the element which this ExternalFileReference is associated with.

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method
Static Member
IsValidExternalFileReference

Checks an ExternalFileReference to see if it is properly created.

Public Method
IsValidPathTypeForExternalFileReference

Checks whether a PathType enum value will be valid to use with this ExternalFileReference.

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)