ContractHandle クラス

定義

public ref class ContractHandle : IDisposable

public class ContractHandle : IDisposable

type ContractHandle = class
    interface IDisposable

Public Class ContractHandle
Implements IDisposable

継承

Object

ContractHandle

実装

IDisposable

例

次の例は、パイプラインのアドイン側のコントラクトからビューへのアダプターで有効期間トークン ハンドルを設定する方法を示しています。

private CalculatorContracts.ICalc2Contract _contract;

private System.AddIn.Pipeline.ContractHandle _handle;

public CalculatorContractToViewHostAdapter(ICalc2Contract contract) {
    _contract = contract;
    _handle = new System.AddIn.Pipeline.ContractHandle(contract);
}

Private _contract As ICalc2Contract
Private _handle As ContractHandle

Public Sub New(ByVal contract As ICalc2Contract)
    _contract = contract
    _handle = New ContractHandle(contract)
End Sub

注釈

アドイン モデルは、アドインがアプリケーション ドメイン間およびプロセス間で通信する機能を提供するため、ガベージ コレクターに依存してそれらを再利用することはできません。 このクラスは、コントラクトの有効期間トークンを取得することによって、アドインの参照カウント メカニズムを提供します。

ContractHandle オブジェクトが構築されると、コンストラクターに渡されるコントラクトでAcquireLifetimeToken メソッドが呼び出されます。 ContractHandle オブジェクトが破棄または終了されると、コントラクトのRevokeLifetimeToken メソッドが呼び出され、コントラクトの保留が解除されます。

アダプターはコントラクトを実装します。 ContractHandle クラスは、パイプライン開発者が適応中のコントラクトの有効期間を管理できるように、コントラクトからビューへのアダプターで使用するように設計されています。 通常、このクラスのインスタンスはアダプター クラスの構築中にインスタンス化され、アダプターのインスタンス フィールドに格納されます。 アダプター クラスがガベージ コレクションされると、 ContractHandle オブジェクトも収集され、 ContractHandle オブジェクトはコントラクトの有効期間トークンを取り消します。

ビューからコントラクトへのアダプターは、 ContractBase クラスから継承することをお勧めします。 その後、 IContractのメンバーに対して既定の実装を使用できます。つまり、特定のコントラクトのメンバーのみを実装する必要があります。