UI_EVENTPARAMS structure (uiribbon.h)

Contains information about a Ribbon event.

Syntax

typedef struct _UI_EVENTPARAMS {
  UI_EVENTTYPE EventType;
  union {
    INT32                  Modes;
    UI_EVENTPARAMS_COMMAND Params;
  };
} UI_EVENTPARAMS;

Members

EventType

One of the values from UI_EVENTTYPE.

Modes

The application modes.

Params

The Command associated with the event.

Remarks

For top-level events (application menu opened/closed, ribbon minimized/expanded/pinned), Modes is present but set to zero (and can be ignored by the application).

For the UI_EVENTTYPE_ApplicationModeSwitched event, Modes specifies which modes have been set. (This is the same integer value that is passed to SetModes to switch modes in the first place.)

For all other events, Params contains additional data about the event.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Header	uiribbon.h

See also

OnUIEvent

Reconfiguring the Ribbon with Application Modes

SetModes

Structures