M

WorksharingUtils.GetModelUpdatesStatus

Description:
Gets the status of a single element in the central model.

Remarks:

This method returns a locally cached value which may not be up to date with the current state of the element in the central. Because of this, the return value is suitable for reporting to an interactive user (e.g. via a mechanism similar to Worksharing display mode), but cannot be considered a reliable indication of whether the element can be immediately edited by the application. Also, the return value may not be dependable in the middle of a local transaction. See the remarks on WorksharingUtils for more details.

For performance reasons, the model is not validated to be workshared, and the element id is also not validated; the element will not be expanded.

public static ModelUpdatesStatus GetModelUpdatesStatus(
	Document document,
	ElementId elementId
)

Public Shared Function GetModelUpdatesStatus ( 
	document As Document,
	elementId As ElementId
) As ModelUpdatesStatus

public:
static ModelUpdatesStatus GetModelUpdatesStatus(
	Document^ document, 
	ElementId^ elementId
)

static member GetModelUpdatesStatus : 
        document : Document * 
        elementId : ElementId -> ModelUpdatesStatus

Document

document

The document containing the element.
ElementId

elementId

The id of the element.

Return Value ModelUpdatesStatus The status of the element in the local session versus the central model.

ArgumentNullException

A non-optional argument was null