Document.EnableWorksharing

Public Class

Enables worksharing in the document.

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

Syntax

public void EnableWorksharing(
  string worksetNameGridLevel,
  string worksetName
)

Parameters

worksetNameGridLevelString

Name of workset for grids and levels.

worksetNameString

Name of workset for all other elements.

Exceptions

Exception

Condition

ArgumentException

worksetNameGridLevel is an empty string. -or- worksetName is an empty string. -or- worksetNameGridLevel cannot include prohibited characters, such as ”{, }, [, ], |, ;, less-than sign, greater-than sign, ?, `, ~”. -or- worksetName cannot include prohibited characters, such as ”{, }, [, ], |, ;, less-than sign, greater-than sign, ?, `, ~”.

ArgumentNullException

A non-optional argument was null

ForbiddenForDynamicUpdateException

This method may not be called during dynamic update.

InvalidOperationException

The document does not allow worksharing to be enabled. -or- This Document is in an edit mode. -or- This Document is a workshared document. -or- There is a transaction phase left open (such as a transaction, sub-transaction of transaction group) at the time of invoking this method.

OperationCanceledException

Enabling worksharing was cancelled.

Remarks

The document’s Undo history will be cleared by this command. As a result, this command and others executed before it cannot be undone.

All transaction phases (e.g. transactions transaction groups and sub-transaction) that were explicitly started must be finished prior to calling this method.