IOleComponentUIManager.OnUIEvent Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Informs the SOleComponentUIManager service of a UI event.

public:
 void OnUIEvent(System::UInt32 dwCompRole, Guid % rclsidComp, Guid % pguidUIEventGroup, System::UInt32 nUIEventId, System::UInt32 dwUIEventStatus, System::UInt32 dwEventFreq, cli::array <Microsoft::VisualStudio::OLE::Interop::RECT> ^ prcEventRegion, System::Object ^ % pvarEventArg);

public void OnUIEvent (uint dwCompRole, ref Guid rclsidComp, ref Guid pguidUIEventGroup, uint nUIEventId, uint dwUIEventStatus, uint dwEventFreq, Microsoft.VisualStudio.OLE.Interop.RECT[] prcEventRegion, ref object pvarEventArg);

abstract member OnUIEvent : uint32 * Guid * Guid * uint32 * uint32 * uint32 * Microsoft.VisualStudio.OLE.Interop.RECT[] * obj -> unit

Public Sub OnUIEvent (dwCompRole As UInteger, ByRef rclsidComp As Guid, ByRef pguidUIEventGroup As Guid, nUIEventId As UInteger, dwUIEventStatus As UInteger, dwEventFreq As UInteger, prcEventRegion As RECT(), ByRef pvarEventArg As Object)

Parameters

dwCompRole

UInt32

[in] Role of the affected in-place VSPackage object. For valid dwCompRole values, see OLEROLE.

rclsidComp

Guid

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

pguidUIEventGroup

Guid

[in] Uniquely identifies the UI events group of the in-place VSPackage object.

nUIEventId

UInt32

[in] Identifies the event using a combination of the events group and event ID.

dwUIEventStatus

UInt32

[in] Represents the status of the event. For valid dwUIEventStatus values, see OLEUIEVENTSTATUS.

dwEventFreq

UInt32

[in] Indicates how often the event occurs. For valid dwEventFreq values, see OLEUIEVENTFREQ.

prcEventRegion

RECT[]

[in] Screen coordinates of the region that might be affected by the event. The environment uses this information to avoid the region.

pvarEventArg

Object

[in] Contains event-specific information if applicable. Typically, pvarEventArg will be null.

Remarks

COM Signature

From oleipc.idl:

void IOleComponentUIManager::OnUIEvent(  
   [in] DWORD dwCompRole,  
   [in] REFCLSID rclsidComp,  
   [in] const GUID *pguidUIEventGroup,  
   [in] DWORD nUIEventId,  
   [in] DWORD dwUIEventStatus,  
   [in] DWORD dwEventFreq,  
   [in] RECT *prcEventRegion,  
   [in] VARIANT *pvarEventArg  
);  

The functionality provided by OnUIEvent is also available with the SVsStatusbar service. OnUIEvent can be used to control various fields in the environment's status bar. It is intended to insulate an in-place VSPackage object from interacting directly with any environment-specific UI peculiarities.

A call to OnUIEvent communicates an event's identifier, its status, its frequency, and the region affected. The following events are currently supported by OnUIEvent.

Events
uieventidSetTextLinePos	uieventidSetGraphicYPos
uieventidSetTextColPos	uieventidSetGraphicXSize
uieventidSetTextSelMode	uieventidSetGraphicYSize
uieventidSetTextCharPos	uieventidSetGraphicXPos
uieventidSetTextInsMode	uieventidAnimateIcon