VsRdtFlags Enumeration

 

Specifies options for a document in the running document table (RDT).

Namespace:   Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

[FlagsAttribute]
public enum VsRdtFlags

Member nameDescription
CanBuildFromMemory

Indicates that a save of the document is not forced on a build.

CantSave

Combination of RDT_DontSave and RDT_DontSaveAs flags.

CaseSensitive

When comparing MkDocument strings, perform a case-sensitive comparison of the strings.

DOCMASK

Mask of the flags from DontSaveAs through DontAddToMRU. Allow __VSCREATEDOCWIN flags in document mask.

DontAddToMRU

Do not add to the list of most recently used files.

DontAutoOpen

Indicates that the document is not persisted in the list of documents that can be opened when the solution is re-opened. Such a document would not be opened using an editor factory, but might be opened using a wizard or special programmatic code.

DontPollForState

Do not poll for changes to the document's dirty or read-only state. The document owner must take responsibility for explicitly updating the state using UpdateDirtyState or UpdateReadOnlyState.

DontSave

Any document marked with this value is not included in the list of documents shown in the SaveChanges dialog box. The Save Changes dialog box is displayed when the user selects Exit from the File menu.

DontSaveAs

Indicates that the SaveAs command should not be made available for this document.

EditLock

Places an edit lock on the document.

Lock_WeakEditLock

Places a weak edit lock on the document. This flag must be ORed with EditLock when registering a weak edit lock. This flag is used in this combination when using RegisterDocumentLockHolder.

NoLock

Indicates that no lock is placed on the document.

NonCreatable

Indicates that the document is created through some special programmatic means. For example, using a wizard. If you specify the NonCreatable flag, then the DontAutoOpen flag automatically applies to your document.

PlaceHolderDoc

Used in the implementation of miscellaneous files. Prevents the Miscellaneous Files project from calling the CreateDocumentWindow method on the document added to the project.

ProjSlnDocument

Set automatically by the environment when a solution or project is opened. Used to flag solution and project files in the running document table. Clients are required to set this flag in the case of nested projects.

ReadLock

Places a read lock on the document.

RequestUnlock

Requests an unlock of the document.

SAVEMASK

Mask of the Unlock_ Unlock_NoSave, Unlock_SaveIfDirty, and Unlock_PromptSave flags.

Unlock_NoSave

Used by UnlockDocument. Release the edit lock and do not save.

Unlock_PromptSave

Used by the UnlockDocument method. Release the edit lock and prompt the user to save the file.

Unlock_SaveIfDirty

Used by the UnlockDocument method. Release the edit lock and save the file if it is dirty.

VirtualDocument

Exclude this document from being considered in the documents collection for the automation model.

Return to top
Show: