RevitLinkOptions

Public Class

This class contains the options in use when creating or loading a Revit link.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.RevitLinkOptions

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

Syntax

public class RevitLinkOptions : IDisposable

The RevitLinkOptions type exposes the following members.

Constructors

Name

Description

Public Method
RevitLinkOptions(Boolean)

Creates a RevitLinkOptions object, specifying relative or absolute path type. If the link is workshared, all worksets will be opened.

Public Method
RevitLinkOptions(RevitLinkOptions)

Constructs a new copy of the input RevitLinkOptions object.

Public Method
RevitLinkOptions(Boolean, WorksetConfiguration)

Creates a RevitLinkOptions object, specifying relative or absolute path type, and the desired workset configuration.

Properties

Name

Description

Public Property

IsRelative

The type of path to use when creating the link. If true, Revit will store a relative path for the link. If false, Revit will store an absolute path. If the link is to a Revit Server location, isRelative must be false.

Public Property
IsValidObject

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

Methods

Name

Description

Public Method

Dispose

Releases all resources used by the RevitLinkOptions

Public Method

Equals

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

Public Method

GetHashCode

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

Public Method

GetType

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

Public Method
Code Example

GetWorksetConfiguration

Gets the set of worksets to open when creating the link.

Public Method

SetWorksetConfiguration

Sets the set of worksets to open when creating the link.

Public Method

ToString

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