RelinquishOptions

Public Class

Options to control behavior of relinquishing ownership of elements and worksets.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.RelinquishOptions

Namespace: Autodesk.Revit.DB

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

Syntax

public class RelinquishOptions : IDisposable

The RelinquishOptions type exposes the following members.

Constructors

Name

Description

---

Public Method
RelinquishOptions

Constructs a new instance of RelinquishOptions.

---

Properties

Name

Description

---

Public Property

CheckedOutElements

True means all elements checked out by the current user should be relinquished. False means none of these are relinquished.

---

Public Property

FamilyWorksets

True means all family worksets owned by the current user should be relinquished. False means none of these are relinquished.

---

Public Property
IsValidObject

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

---

Public Property

StandardWorksets

True means all project standards worksets owned by the current user should be relinquished. False means none of these are relinquished.

---

Public Property
UserWorksets

True means all user-created worksets owned by the current user should be relinquished. False means none of these are relinquished.

---

Public Property

ViewWorksets

True means all view worksets owned by the current user should be relinquished. False means none of these are relinquished.

---

Methods

Name

Description

---

Public Method

Dispose

Releases all resources used by the RelinquishOptions

---

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

ToString

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

---

Remarks

The settings correspond to the checkboxes in the Synchronize with Central dialog in the section “After synchronizing, relinquish the following worksets and elements:”.

An element can be owned (reflected in the “Edited By” parameter) either by being checked out (“borrowed”) or by belonging to a checked out workset.

Relinquishing a workset will relinquish all its unmodified elements that the current user owns.

The subtle interactions between checking out elements and checking out worksets are beyond the scope of the documentation for this class. But as an example, if a wall is borrowed (explicitly checked out) and then its workset is checked out, then the wall is no longer considered borrowed because the workset ownership implicitly grants ownership of all elements in the workset (except elements borrowed by other users).