2023 Class
Changes 0
C

RelinquishOptions

Description:
Options to control behavior of relinquishing ownership of elements and worksets.
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).

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.RelinquishOptions
public class RelinquishOptions : IDisposable
Name Return Type Description
C RelinquishOptions(Boolean) None Constructs a new instance of RelinquishOptions.
Name Return Type Description
M Dispose() None Releases all resources used by the
Name Return Type Description
P CheckedOutElements bool True means all elements checked out by the current user should be relinquished. False means none of these are relinquished.
P FamilyWorksets bool True means all family worksets owned by the current user should be relinquished. False means none of these are relinquished.
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity.
P StandardWorksets bool True means all project standards worksets owned by the current user should be relinquished. False means none of these are relinquished.
P UserWorksets bool True means all user-created worksets owned by the current user should be relinquished. False means none of these are relinquished.
P ViewWorksets bool True means all view worksets owned by the current user should be relinquished. False means none of these are relinquished.