IVsMultiViewDocumentView.ActivateLogicalView Method

Article
03/06/2013

Identifies which view is activated when the editor window is instantiated.

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

Syntax

'Declaration
Function ActivateLogicalView ( _
    ByRef rguidLogicalView As Guid _
) As Integer

int ActivateLogicalView(
    ref Guid rguidLogicalView
)

int ActivateLogicalView(
    [InAttribute] Guid% rguidLogicalView
)

abstract ActivateLogicalView : 
        rguidLogicalView:Guid byref -> int

function ActivateLogicalView(
    rguidLogicalView : Guid
) : int

Parameters

rguidLogicalView
Type: System.Guid%
[in] GUID identifying the logical view.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsMultiViewDocumentView::ActivateLogicalView(
   [in] REFGUID rguidLogicalView
);

The value passed into the rguidLogicalView parameter of ActivateLogicalView is the same value passed into the rguidLogicalView of InitializeEditorInstance. Use this value in your editor factory implementation to bring the correct tab (that is, logical view) forward in the view and give it focus.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.