Description This command is used to check out the copy of the focused document that resides in your version control database. The document does not need to be the active document and, in fact, need not be open at all.

Use First, ensure that the document you wish to check out is focused in the Projects panel.

After launching the command, the Check out file(s) dialog appears, with the entry for the focused document selected ready for checking out. The Advanced button provides access to advanced check out options for your particular version control software. These could include how to treat a writeable copy of the file already in existence in your working folder and what time-stamp to use. After clicking OK, the version of the document stored in your version control database will be checked out to your work area. The VCS display icon for the document's entry in the Projects panel will change to (Checked out by me), if you are the only person to currently have the file checked out, or (Checked out), if more than one person has checked out the file, or if you have checked in your copy but it is still checked out by others elsewhere.

If, when checking out the document, the advanced check out options for your version control software provide an option to allow multiple checkouts, disabling this option means that you will be the only one allowed to have this particular document checked out at the current time. The VCS display icon in this case, will change to (Checked out by me exclusively).

If another user has checked out a document and disabled multiple checkouts, the CVS display icon will change to (Checked out exclusively).

Notes Focus a document in the Projects panel simply by clicking on its entry.

If the focused document is open in the main design window, you should close and reopen the document after using this command, in order to display and work on the checked out version of the file.

Allowing multiple checkouts is a feature in your version control software. For information on this feature, consult your version control software documentation.

With respect to multiple check outs of the same document, this is not possible for binary files. In this case, only one person may work on such a file at any one time. If you are the only person to check out a binary file, the Projects panel will reflect this using the VCS display icon (Checked out by me). If a binary file is already checked out by another user, the VCS display icon will be (Checked out) and the command to check out for this particular document will be unavailable.

To display the current version control status of documents in the Projects panel, enable the Show VCS status option in the Projects Panel tab of the Design Explorer Preferences dialog. Hovering the cursor over the iconic status entry for a document will provide textual confirmation of its status.

Process WorkspaceManager:VersionControl

Parameters ObjectKind=FocusedDocument|Action=Checkout

Links Add Active Document to Version Control
Add Focused Document to Version Control
Add Project To Version Control
Check In Active Document to Version Control
Check In Active Document to Version Control
Check In Focused Document to Version Control
Check Out Active Document from Version Control
Check Out Active Document from Version Control
Compare Local and VCS Copies of Active Document
Compare Local and VCS Copies of Active Document
Compare Local and VCS Copies of Focused Document
Display Version Control Property Information for Active Document
Display Version Control Property Information for Active Document
Display Version Control Property Information for Focused Document
Get Latest Version of Active Document
Get Latest Version of Active Document
Get Latest Version of Focused Document
Refresh Link between Local Project and VCS Database
Refresh Link between Local Project and VCS Database
Remove Active Document from Version Control
Remove Focused Document from Version Control
Remove Project From Version Control
Run Version Control Software
Run Version Control Software
Show Version Control History for Active Document
Show Version Control History for Active Document
Show Version Control History for Focused Document
Synchronize Project With Version Control
Undo Check Out of Active Document
Undo Check Out of Active Document
Undo Check Out of Focused Document