VsFramePropID Enumeration

 

Specifies property identifiers for window frames, document frames, and tool window frames.

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

public enum VsFramePropID

Member nameDescription
AltDocData

If this window is only editing a piece of a larger document then AltDocData is the DocData object for the piece of the document that is being edited within the window, whereas the RDTDocData is the DocData object for the entire document registered in the RDT. AltDocData objects are not registered in the RDT. Document windows that have AltDocData objects are created using the CDW_fAltDocData flag.

BitmapIndex

The index of the image to use in the bitmap strip for the window frame icon.

BitmapResource

The resource number of the bitmap in a satellite DLL.

Caption

The full window caption.

CmdUIGuid

The GUID used to control visibility of toolbars and AutoVisible tool windows.

CreateDocWinFlags
CreateToolWinFlags

The __VSCREATETOOLWIN flags passed to CreateToolWindow.

DocCookie
DocData

The document frame returns AltDocData if it is available, otherwise it returns RDTDocData.

DocView

The object that fills the client area of a window.

DontAutoOpen

A window should be reopened when a solution is opened (the default is false).

EditorCaption

The portion of the caption defined by the editor implementation.

ExtWindowObject

Returns the Environment's "Window" automation IDispatch object.

FrameMode

Controls the display mode of a tools window.

GuidAutoActivate

Obsolete. Do not use.

guidEditorType

The guidEditorType that uniquely identifies which IVsEditorFactory created the document.

GuidPersistenceSlot

The GUID that uniquely identifies a tool window type.

HideToolwinContainer

The tool window's container is hidden when saving a data file.

Hierarchy

The owning IVsHierarchy.

Icon

An actual handle to an icon (HICON) resource is retrieved if the document has one.

InheritKeyBindings

The GUID most often used by a window to inherit the key bindings of the text editor (for example, pFrame->SetGuidProperty(VSFPROPID_InheritKeyBindings, CMDUIGUID_TextEditor)).

IsPinned

Indicates whether a window is pinned. If true, the window is pinned.

IsProvisional

A tri-state value indicating whether a window is provisional.

IsSearchEnabled

Returns whether the window supports search (an IVsWindowSearchHost was created and associated with the frame, the search was setup with the host, and the search is enabled by the provider).

IsWindowTabbed

Indicates if the window is not tabbed (returns 0), is tabbed and is an active tab (returns 1), or is tabbed and is not an active tab (returns 2). Document windows always return 0.

ItemID

The VSITEMID of the document.

MDIContainerID

The identifier of the container (tab) group for the multiple-document interface (MDI) window.

MultiInstanceToolNum

The identifier of a multi-instance tool window.

NavigationInterface

The navigation delegate for this frame.

NextCloneID

The next instance identifier available among sibling clones.

NotifyOnActivate

Indicates whether to send the FRAMESHOW_WinActivated notification when a window is activated. If true, the notification is sent.

OLEDocObjectDocument

Indicates if the pane is holding an OLE document object.

OverrideCaption

Overrides the generated caption for this frame. A null value restores the default behavior.

OverrideDirtyState

The tri-state value used to control the dirty star (*) in a window caption.

OverrideToolTip

Overrides the generated tooltip for this frame. A null value restores the default behavior.

OwnerCaption

The portion of the caption defined by the owner IVsHierarchy.

ParentFrame

The IVsWindowFrame of the parent container for an OwnerDocked window.

ParentHwnd

The handle to a window (HWND) parent of an OwnerDocked window.

pszMkDocument

The path to the document (pszMkDocument) passed to CreateDocumentWindow.

pszPhysicalView

The type of window created by the IVsEditorFactory (for example, "Form").

RDTDocData

The DocData registered in the running document table (RDT) for the document in this frame.

ReplaceDocumentToolbars

Indicates whether any toolbars that are specific to the currently-active document should be hidden. A value of true indicates that when the tool window is active, any toolbars that are specific to the currently active document should be hidden. The default is false. This property only has an effect when the tool window also supplies a CmdUI GUID using the VSFPROPID_CmdUIGuid property. This property is used only for tool windows.

SearchHost

Retrieves the IVsWindowSearchHost associated with the window or creates a search host for a search control with shell-owned positioning in the top frame area.

SearchPlacement

The search control placement values from __VSSEARCHPLACEMENT.

ShortCaption

The partial window caption.

SPFrame

An IServiceProvider that is the site object for the DocView object.

SPProjContext

The IServiceProvider provided by the owning IVsHierarchy.

TabImage

A handle to a bitmap (HBITMAP) for the image to be displayed on a tab for this frame (the caller must cache and release this object).

Thumbnail

A handle to a bitmap (HBITMAP) thumbnail of the contents of the frame.

ToolbarHost

The IVsToolWindowToolbarHost used to add toolbars to a window.

ToolWindowDocCookie

A pointer to the IVsRunningDocumentTable (RDT) key for the document associated with a tool window (for example, the Code Definition Window).

Type

The frame type (1 for a document frame or 2 for a tool frame) of the window.

UserContext

The tool window user context (IVsUserContext).

ViewHelper

The property that can be set on a Helper object to override add or override interfaces. This property is normally implemented on the DocView object. ViewHelper can implement the following interfaces: IVsWindowFrameNotify, IOleCommandTarget, IVsToolboxUser, IVsDocOutlineProvider, IDocHostUIHandler, IVsBackForwardNavigation, IVsWindowView, and IVsStatusbarUser.

WindowHelpCmdText

The command text for cmdidWindowHelp (for example, Help on: Help Index).

WindowHelpKeyword

The keyword to be used for cmdidWindowHelp.

WindowState

The current state of the window (Normal, Minimized, or Maximized).

Return to top
Show: