`event` 关键字（C++/CLI 和 C++/CX）

项目
06/16/2023

event 关键字声明了一个事件，以就发生的相关事件向注册的订阅服务器（事件处理程序）发出通知。

所有运行时

C++/CX 支持声明事件成员或事件块。事件成员是用于声明事件块的速记属性。默认情况下，事件成员声明 add、remove 和 raise 函数，而这些函数将在事件块中显式声明。若要自定义事件成员中的函数，请改为声明一个事件块，然后替代所需的函数。

语法

// event data member
modifier event delegate^ event_name;

// event block
modifier event delegate^ event_name
{
   modifier return_value add(delegate^ name);
   modifier void remove(delegate^ name);
   modifier void raise(parameters);
}

参数

modifier
修饰符可用于事件声明或事件访问器方法。可能值为 static 和 virtual。

delegate
签名必须与事件处理程序匹配的 delegate。

event_name
事件名称。

return_value
事件访问器方法的返回值。若要具有可验证性，返回类型必须是 void。

parameters
（可选）raise 方法的参数，与 delegate 参数的签名匹配。

备注

事件是委托和事件处理程序之间的关联。事件处理程序是在事件被触发时响应的成员函数。它允许来自任何类的客户端注册与委托的签名和返回类型匹配的方法。

有两种类型的事件声明：

事件数据成员
编译器会自动以委托类型成员的形式为事件创建存储空间，并创建内部 add、remove 和 raise 成员函数。必须在类中声明事件数据成员。委托的返回类型必须与事件处理程序的返回类型匹配。

事件块
事件块可显式声明并自定义 add、remove 和 raise 方法的行为。

可以使用 operator += 和 operator -= 添加和删除事件处理程序，或显式调用 add 和 remove 方法。

event 是上下文相关的关键字。有关详细信息，请参阅上下文相关关键字。

Windows 运行时

备注

有关详细信息，请参阅事件 (C++/CX)。

若要添加和稍后删除事件处理程序，请保存 add 操作返回的 EventRegistrationToken 结构。然后在 remove 操作中，使用保存的 EventRegistrationToken 结构来标识要删除的事件处理程序。

要求

编译器选项：/ZW

公共语言运行时

使用 event 关键字，可以声明事件。事件是类在相关事件发生时提供通知的一种方式。

语法

// event data member
modifier event delegate^ event_name;

// event block
modifier event delegate^ event_name
{
   modifier return_value add(delegate^ name);
   modifier void remove(delegate^ name);
   modifier void raise(parameters);
}

参数

modifier
修饰符可用于事件声明或事件访问器方法。可能值为 static 和 virtual。

delegate
签名必须与事件处理程序匹配的 delegate。

event_name
事件名称。

return_value
事件访问器方法的返回值。若要具有可验证性，返回类型必须是 void。

parameters
（可选）raise 方法的参数，与 delegate 参数的签名匹配。

备注

事件是委托和事件处理程序之间的关联。事件处理程序是在事件被触发时响应的成员函数。它允许来自任何类的客户端注册与基础委托的签名和返回类型匹配的方法。

委托可以具有一个或多个关联的方法。当代码指示事件发生时，将调用这些方法。程序中的事件可供面向 .NET Framework 公共语言运行时的其他程序使用。

有两种类型的事件声明：

事件数据成员
编译器将数据成员事件的存储创建为委托类型的成员。必须在类中声明事件数据成员。这也称为普通事件。有关示例，请参阅代码示例。

事件块
事件块允许通过实现 add、remove 和 raise 方法来自定义 add、remove 和 raise 方法的行为。 add、remove 和 raise 方法的签名必须与委托的签名匹配。事件块事件不是数据成员。任何用作数据成员的用法都会生成编译器错误。

事件处理程序的返回类型必须与委托的返回类型匹配。

在 .NET Framework 中，您可以将数据成员视为方法本身（即，其对应委托的 Invoke 方法）。为此，请预定义用于声明托管事件数据成员的委托类型。相反，托管事件方法隐式定义了相应的托管委托（如果尚未定义）。有关示例，请参阅本文末尾的代码示例。

声明托管事件时，可以指定在使用运算符 += 和 -= 添加或删除事件处理程序时将调用的 add 和 remove 访问器。 add、remove 和 raise 方法可以显式调用。

在 Microsoft C++ 中创建和使用事件必须执行以下步骤：

创建或标识委托。如果要定义自己的事件，还必须确保有一个可与 event 关键字一起使用的委托。例如，如果该事件在 .NET Framework 中进行了预定义，则该事件的使用者只需知道委托的名称。
创建包括以下内容的类：
- 从委托创建的事件。
- （可选）验证使用 event 关键字声明的委托实例是否存在的方法。否则，此逻辑必须放在激发事件的代码中。
- 调用此事件的方法。这些方法可以替代一些基类功能。
此类将定义该事件。
定义一个或多个将方法连接到该事件的类。其中每个类会将一个或多个方法与基类中的事件相关联。
使用事件：
- 创建包含事件声明的类的对象。
- 创建包含事件定义的类的对象。

有关 C++/CLI 事件的详细信息，请参阅接口中的事件。

要求

编译器选项：/clr

示例

下面的代码示例演示如何声明委托、事件和事件处理程序对。它展示了如何订阅（添加）、调用和取消订阅（删除）事件处理程序。

// mcppv2_events.cpp
// compile with: /clr
using namespace System;

// declare delegates
delegate void ClickEventHandler(int, double);
delegate void DblClickEventHandler(String^);

// class that defines events
ref class EventSource {
public:
   event ClickEventHandler^ OnClick;   // declare the event OnClick
   event DblClickEventHandler^ OnDblClick;   // declare OnDblClick

   void FireEvents() {
      // raises events
      OnClick(7, 3.14159);
      OnDblClick("Hello");
   }
};

// class that defines methods that will called when event occurs
ref class EventReceiver {
public:
   void OnMyClick(int i, double d) {
      Console::WriteLine("OnClick: {0}, {1}", i, d);
   }

   void OnMyDblClick(String^ str) {
      Console::WriteLine("OnDblClick: {0}", str);
   }
};

int main() {
   EventSource ^ MyEventSource = gcnew EventSource();
   EventReceiver^ MyEventReceiver = gcnew EventReceiver();

   // hook handler to event
   MyEventSource->OnClick += gcnew ClickEventHandler(MyEventReceiver, &EventReceiver::OnMyClick);
   MyEventSource->OnDblClick += gcnew DblClickEventHandler(MyEventReceiver, &EventReceiver::OnMyDblClick);

   // invoke events
   MyEventSource->FireEvents();

   // unhook handler to event
   MyEventSource->OnClick -= gcnew ClickEventHandler(MyEventReceiver, &EventReceiver::OnMyClick);
   MyEventSource->OnDblClick -= gcnew DblClickEventHandler(MyEventReceiver, &EventReceiver::OnMyDblClick);
}

OnClick: 7, 3.14159

OnDblClick: Hello

下面的代码示例展示了用于生成普通事件的 raise 方法的逻辑。如果此事件有一个或多个订阅服务器，调用 raise 方法会隐式或显式调用委托。如果委托的返回类型不是 void 并且没有事件订阅服务器，则 raise 方法将返回委托类型的默认值。如果没有事件订阅者，调用 raise 方法会立即返回并且不会引发异常。如果委托返回类型不是 void，则将返回该委托类型。

// trivial_events.cpp
// compile with: /clr /c
using namespace System;
public delegate int Del();
public ref struct C {
   int i;
   event Del^ MyEvent;

   void FireEvent() {
      i = MyEvent();
   }
};

ref struct EventReceiver {
   int OnMyClick() { return 0; }
};

int main() {
   C c;
   c.i = 687;

   c.FireEvent();
   Console::WriteLine(c.i);
   c.i = 688;

   EventReceiver^ MyEventReceiver = gcnew EventReceiver();
   c.MyEvent += gcnew Del(MyEventReceiver, &EventReceiver::OnMyClick);
   Console::WriteLine(c.i);
}

0

688

另请参阅

.NET 和 UWP 的组件扩展

`event` 关键字（C++/CLI 和 C++/CX）

所有运行时

语法

参数

备注

Windows 运行时

备注

要求

公共语言运行时

语法

参数

备注

要求

示例

另请参阅

反馈

反馈

其他资源

event 关键字（C++/CLI 和 C++/CX）

所有运行时

语法

参数

备注

Windows 运行时

备注

要求

公共语言运行时

语法

参数

备注

要求

示例

另请参阅

反馈

反馈

其他资源

`event` 关键字（C++/CLI 和 C++/CX）