IOleInPlaceComponentUIManager.SetActiveUI Method

  • [アーティクル]

Allows a UI active VSPackage object to change the menus, toolbars, or commands that are displayed on its behalf by the environment.

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

Syntax

'宣言
Function SetActiveUI ( _
    dwCompRole As UInteger, _
    ByRef rclsid As Guid, _
    cCmdGrpId As UInteger, _
    rgnCmdGrpId As Integer() _
) As Integer
'使用
Dim instance As IOleInPlaceComponentUIManager
Dim dwCompRole As UInteger
Dim rclsid As Guid
Dim cCmdGrpId As UInteger
Dim rgnCmdGrpId As Integer()
Dim returnValue As Integer

returnValue = instance.SetActiveUI(dwCompRole, _
    rclsid, cCmdGrpId, rgnCmdGrpId)

int SetActiveUI(
    uint dwCompRole,
    ref Guid rclsid,
    uint cCmdGrpId,
    int[] rgnCmdGrpId
)

int SetActiveUI(
    [InAttribute] unsigned int dwCompRole, 
    [InAttribute] Guid% rclsid, 
    [InAttribute] unsigned int cCmdGrpId, 
    [InAttribute] array<int>^ rgnCmdGrpId
)

function SetActiveUI(
    dwCompRole : uint, 
    rclsid : Guid, 
    cCmdGrpId : uint, 
    rgnCmdGrpId : int[]
) : int

Parameters

  • dwCompRole
    Type: System.UInt32

    [in] Role of the in-place object requesting the user interface change. For a list of valid dwCompRole values, see OLEROLE.

  • rclsid
    Type: System.Guid%

    [in] Class identifier (CLSID) of the in-place object requesting the change.

  • cCmdGrpId
    Type: System.UInt32

    [in] Count of the toolbars identified by rgnCmdGrpId.

  • rgnCmdGrpId
    Type: []

    [in] Array of identifiers of toolbars to be displayed in the update.

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 oleipc.idl:

HRESULT IOleInPlaceComponentUIManager::SetActiveUI(
   [in] DWORD dwCompRole,
   [in] REFCLSID rclsid,
   [in] ULONG cCmdGrpId,
   [in] LONG *rgnCmdGrpId
);

Permissions

See Also

Reference

IOleInPlaceComponentUIManager Interface

IOleInPlaceComponentUIManager Members

Microsoft.VisualStudio.Shell.Interop Namespace