Workspace Object

See Also

A workspace is a Repository object that can provide a context for your work separate from other work occurring in the Repository.

When to Use

Use the Workspace object to control the contents of a workspace.

Properties

Property Description
CheckedOutToWorkspace Always null, because a workspace cannot be contained in or checked out to another workspace.
IsCheckedOut Always FALSE, because a workspace cannot be present in (or checked out to) another workspace.
IsFrozen Always FALSE, because you cannot freeze a workspace.
Interface The specified object interface.
InternalID The internal object identifier of the workspace.
Name The name of the workspace.
Object Retrieves the specified Repository object.
ObjectID The object identifier of the workspace.
PredecessorCreationVersion Always null, because each workspace has only one version.
Repository The open Repository instance through which this workspace was instantiated.
ResolutionType Always LATEST_VERSION, because each workspace has only one version.
RootObject The root Repository object of the currently open Repository.
Transaction The transaction processing interface.
Type An object identifier of the type to which this workspace conforms. The property is always the object identifier of the workspace definition object of the Type Information Model.
Version Retrieves the specified object version.
VersionID The object-version identifier of the workspace.
VersionInternalID The internal object-version identifier of the workspace.

Methods

Method Description
Checkin Returns an error, because a workspace cannot be present in (or checked out to) another workspace.
Checkout Returns an error, because a workspace cannot be present in (or checked out to) another workspace.
Create Returns an error, because you cannot create a new Repository database from within a workspace.
CreateObject Creates a new Repository object in the currently open Repository.
CreateVersion Returns an error, because each workspace has only one version.
Delete Deletes a workspace.
FreezeVersion Returns an error, because you cannot freeze a workspace.
InternalIDToObjectID Converts an internal identifier into an object identifier.
InternalIDToVersionID Converts an internal object-version identifier into an object-version identifier.
Lock Locks the workspace.
MergeVersion Returns an error, because each workspace has only one version.
ObjectIDToInternalID Converts an object identifier into an internal identifier.
Open Returns an error, because you cannot open a new Repository database from within a workspace.
Refresh Refreshes the cached image of a Repository.
Refresh (from IRepositoryObjectVersion) Refreshes the cached image of the RepositoryObjectVersion representing the workspace.
VersionIDToInternalID Converts an object-version identifier into an internal object-version identifier.

Collections

Collection Description
Checkouts The collection of object versions checked out to the workspace.
Containers The collection of things that contain this workspace. The collection has only one item, the Root Object.
Contents The collection of object versions present in the workspace.
ObjectVersions The collection of all the versions of the Repository object representing the workspace. Always contains exactly one item, because you cannot invoke CreateVersion on a workspace.
PredecessorVersions Always null, because you cannot invoke CreateVersion on a workspace.
Properties The collection of all the properties that are attached to the workspace.
SuccessorVersions Always null, because you cannot invoke CreateVersion on a workspace.
Workspaces Always null, because a workspace cannot be contained in other workspaces.