Receivers 要素 (イベント)Receivers Element (Event)

適用されます: SharePoint 2016 |SharePoint Foundation 2013 |SharePoint オンライン |SharePoint Server 2013Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

指定したリスト テンプレートを使用して作成されたリストで、アイテム イベントの処理に関するイベント レシーバの説明を格納します。Contains the description of an event receiver for handling item events in lists created through the specified list template.

定義Definition

<Receivers
  ListTemplateId = "Text"
  ListTemplateOwner = "Text"
  ListUrl = string
  RootWebOnly = TRUE | FALSE
  Scope = Site | Web>
</Receivers>

要素と属性Elements and attributes

以下のセクションで、属性、子要素、親要素について説明します。The following sections describe attributes, child elements, and parent elements.

属性Attributes

属性Attribute

説明Description

ListTemplateIdListTemplateId

オプションの TextOptional Text. イベント レシーバーが適用されるリスト テンプレートのインデックスを指定します。Specifies the index of the list template to which the event receiver applies. 既定のリスト テンプレートの種類の一覧では、 SPListTemplateTypeを参照してください。For a list of the default list template types, see SPListTemplateType.

ListTemplateOwnerListTemplateOwner

オプションの Text。リスト テンプレートが機能を通じて登録されている場合は、リスト テンプレート所有者の GUID を指定します。または、リスト テンプレートがサイト定義によって登録されている場合は、サイト定義の名前を指定します。Optional Text. Specifies the GUID of the list template owner if the list template is registered through Features, or the name of the site definition if the list template is registered by a site definition.

ListUrlListUrl

オプションの string。イベント レシーバーが適用されるリストの URL を指定します。Optional string. Specifies the URL of the list to which the event receiver applies.

RootWebOnlyRootWebOnly

オプションの Boolean。イベント レシーバーがルート Web にのみ適用される場合は True、それ以外の場合は FalseOptional Boolean. True if the event receiver applies only to the root Web; otherwise, False.

スコープScope

省略可能な列挙体です。Optional enumeration. イベント レシーバーの範囲です。The scope of the event receiver. サイトまたはWebを指定できます。This can be Site or Web. スコープ属性は、サイトに設定されている機能をサイト コレクションのスコープ内で定義されているイベント レシーバーがサイト コレクション レベルで登録されます。When the Scope attribute is set to Site, event receivers that are defined inside of a Feature that is scoped to the site collection are registered at the site collection level. スコープ属性をWebに設定すると、Web 上の Web を対象範囲と機能の内部で定義されているイベント レシーバーが登録されます。When the Scope attribute is set to Web, event receivers that are defined inside of a Feature that is scoped to a Web are registered on the Web.

子要素Child elements

レシーバReceiver

親要素Parent elements

要素Elements

出現回数Occurrences

最小 : 1Minimum: 1

最大 : 制約なしMaximum: Unbounded

Example

この要素の使用方法の例については、「Event Registrations」を参照してください。For an example of how this element is used, see Event Registrations.

受信機のタグは、サイト全体にわたるイベントの登録や、ルート Web のイベントの登録を意味します。A Receivers tag can imply a site-wide event registration or an event registration for the root Web. スコープ属性を使用すると、イベント レシーバーを適用するレベルを定義します。The Scope attribute is used to define at what level the event receivers are applied. 受信機のタグは、 ListTemplateIdまたはListUrlの属性を持たない、イベント レシーバーのフィーチャーと同じスコープで登録されます。If the Receivers tag has no ListTemplateId or ListUrl attribute, the event receiver is registered at the same scope as the Feature.

たとえば、スコープは、Web に設定する機能は、スコープは、Web に設定するイベント レシーバーのコレクションに追加されるイベント レシーバーになります。For example, a Feature that is scoped to the Web results in an event receiver being added to an event receiver collection that is scoped to the Web.