プリイベントハンドラークラスおよびポストイベントハンドラークラスの作成

10 分

イベントハンドラークラスをプリハンドラーおよびポストハンドラーに使用すると、メソッドラッピングにコマンドチェーン (CoC) を使用する方法など、アプリケーションを拡張できます。

イベントハンドラークラスはアプリケーションを拡張するもう 1 つの方法で、他のイベントハンドラークラスと同じ方法で使用します。元のメソッドの前に実行されるプリハンドラーと、後で実装するポストハンドラーを元のメソッドが含むクラスで、プリハンドラーとポストハンドラーを使用できます。ハンドラーは元のメソッドを囲みます。また属性を使用して、プリハンドラーとポストハンドラーの拡張を防止、または許可できます。

プリイベントクラスおよびポストイベントクラス

プリイベントハンドラークラスおよびポストイベントハンドラークラスを追加するには、新しいイベントハンドラークラスを作成します。プロジェクトを右クリックするかコンテキストメニューを有効化し、追加、新規項目、コード、クラス、またはクラスの追加を選択すると、ソリューションエクスプローラーからプロジェクトにクラスを追加できます。

CustTableTableEventHandler など、プリイベントクラスおよびポストイベントクラスの内容を示す名前を入力します。 CustTable はテーブルまたはフォームの場合があるので、CustTable などの開始点としてオブジェクト名を使用し、次に Table などのオブジェクトタイプを追加することをお勧めします。そうすると、EventHandler を使用してそれを追加できます。たとえば、CustTableTableEventHandler と CustTableFormEventHandler という名前の 2 つのイベントハンドラークラスを持つ場合があります。

プリイベントまたはポストイベントを追加するには、イベントハンドラークラス内のメソッドが検出可能であることを確認してください。メソッドで、コンテキストメニューを右クリックまたはアクティブ化した後、次の画像のようにイベントハンドラーメソッドのコピーを選択し、プリイベントハンドラーを選択します。

プリイベントハンドラーを選択した後、イベントハンドラークラスに移動し、メソッドを貼り付けます。メソッドに戻り、ポストイベントハンドラーを選択した後、それをイベントハンドラークラスに貼り付けます。

プリイベントおよびポストイベントに対する 2 つのメソッドが表示され、次のコードサンプルが示すように、これらの 2 つのメソッド (スーパー呼び出し) の間で元のメソッドが呼び出されます。

internal final class CustTableTableEventHandler
{
    /// <summary>
    ///
    /// </summary>
    /// <param name="args"></param>
    [PreHandlerFor(tableStr(CustTable), tableMethodStr(CustTable, insert))]
    public static void CustTable_Pre_delete(XppPrePostArgs args)
    {
        CustTable custTable = args.getThis() as CustTable;

        // do something
    }

    /// <summary>
    ///
    /// </summary>
    /// <param name="args"></param>
    [PostHandlerFor(tableStr(CustTable), tableMethodStr(CustTable, insert))]
    public static void CustTable_Post_delete(XppPrePostArgs args)
    {
        CustTable custTable = args.getThis() as CustTable;

        // do something
    }
}

属性

メソッドに属性を追加して、ユーザーがプリハンドラーやポストハンドラー、その他の拡張機能を使用できなくすることができます。追加できる属性の 3 つのタイプは、hookable、wrappable、replaceable です。

hookable 属性は、次のアクションを実行します。

[Hookable(false)] - プリイベントやポストイベントを作成できない、つまりメソッドが wrappable ではないということで、動作を上書きします。
[Hookable(true)] - プリイベントおよびポストイベントを作成できるように、動作を上書きします。

wrappable 属性は、次のアクションを実行します。

[Wrappable(false)] - メソッドがラップできなくなるように、ラップ対象の (最終でない) パブリックメソッドおよび保護されたメソッドに対する既定の機能を上書きします。つまり、このメソッドはラップ可能ではありません。
[Wrappable(true)] - メソッドをラップすることができるように、最終とマークされたメソッドをラップできないという動作を上書きします。つまり、このメソッドはラップ可能になります。

replaceable 属性は、次のアクションを実行します。

[Replaceable (false)] - コマンドチェーン (CoC) に無条件の次の呼び出しが必ず含まれるように動作を上書きします。
[Replaceable (true)] CoC 拡張子を付けられるように動作を上書きしますが、無条件に次を呼び出す必要はありません。

replaceable メソッドは、ラップ可能である必要もあります。

次のコード例では、[Hookable(false), Wrappable(false)] を使用して、メソッドがプリイベントおよびポストイベントおよび CoC を持つとして保護されている場合を示します。[Hookable(false), Wrappable(false)] は、機能を拡張できないという意味になります。

    /// <summary>
    /// Calculates and sets the <c>AmountCur</c> field using the <c>Quantity</c> and <c>UnitPrice</c>
    /// values.
    /// </summary>
    /// <param name="_qty">
    /// Item quantity on the line.
    /// </param>
    /// <returns>
    /// The <c>AmountCur</c> value.
    /// </returns>
    [Hookable(false), Wrappable(false)]
    public AmountCur calcLineAmount(Qty _qty = this.Quantity)
    {
        return this.salesPurchLineInterface().calcLineAmount(_qty);
    }

メソッドに属性を使用している場合は、機能拡張に注意し、潜在的に機能を損なう可能性があります。

続行

プリイベント ハンドラー クラスおよびポストイベント ハンドラー クラスの作成

プリイベント クラスおよびポストイベント クラス

属性

フィードバック

プリイベントクラスおよびポストイベントクラス