ContractHandle Класс

Определение

Предоставляет методы, для контроля времени жизни надстройки.Provides methods that control the lifetime of an add-in.

public ref class ContractHandle : IDisposable
public class ContractHandle : IDisposable
type ContractHandle = class
    interface IDisposable
Public Class ContractHandle
Implements IDisposable
Наследование
ContractHandle
Реализации

Примеры

В следующем примере показано, как задать маркер маркера времени существования в адаптере "контракт-представление" на стороне надстройки конвейера.The following example shows how to set the lifetime token handle in a contract-to-view adapter on the add-in side of a pipeline.

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

Комментарии

Так как модель надстройки предоставляет возможность взаимодействия между доменами приложений и между процессами, она не может полагаться на то, что сборщик мусора сможет их восстановить.Because the add-in model provides the ability for add-ins to communicate between application domains and between processes, it cannot rely on the garbage collector to reclaim them. Этот класс предоставляет механизм подсчета ссылок для надстройки путем получения маркера времени существования его контракту.This class provides a reference counting mechanism for the add-in by obtaining a lifetime token to its contract.

При ContractHandle создании объекта он вызывает AcquireLifetimeToken метод для контракта, который передается в конструктор.When a ContractHandle object is constructed, it calls the AcquireLifetimeToken method on the contract that is passed to the constructor. Когда ContractHandle объект уничтожается или завершается, он вызывает RevokeLifetimeToken метод в контракте, который удаляет его удержание в контракте.When the ContractHandle object is disposed or finalized, it calls the RevokeLifetimeToken method on the contract, which removes its hold on the contract.

Адаптеры реализуют контракт.Adapters implement the contract. ContractHandleКласс предназначен для использования в адаптере "контракт-представление", чтобы помочь разработчикам конвейера управлять жизненным циклом контракта, который адаптируется.The ContractHandle class is designed to be used in a contract-to-view adapter to help pipeline developers manage the lifetime of the contract that is being adapted. Как правило, экземпляр этого класса создается во время создания класса адаптера и хранится в поле экземпляра адаптера.Typically, an instance of this class is instantiated during the construction of the adapter class and is stored in an instance field of the adapter. При сборе мусора для класса адаптера ContractHandle также собирается объект, и ContractHandle объект будет отзывать маркер времени существования в контракте.When the adapter class is garbage-collected, the ContractHandle object will also be collected and the ContractHandle object will revoke the lifetime token on the contract.

Рекомендуется, чтобы адаптеры с представлением по контракту наследовались от ContractBase класса.It is recommended that your view-to-contract adapters inherit from the ContractBase class. Затем можно использовать реализацию по умолчанию для членов, что IContract означает необходимость реализации только членов конкретного контракта.You can then use a default implementation for the members of IContract, which means you need to implement only the members of your specific contract.

Конструкторы

ContractHandle(IContract)

Инициализирует новый экземпляр класса ContractHandle.Initializes a new instance of the ContractHandle class.

Свойства

Contract

Возвращает контракт, используемый конвейером.Gets the contract used by a pipeline.

Методы

AppDomainOwner(AppDomain)

Возвращает экземпляр адаптера надстройки при создании домена приложения.Gets the instance of the add-in-side adapter when the application domain was created.

ContractOwnsAppDomain(IContract, AppDomain)

Определяет владеет ли выбранный контракт доменом приложения.Determines whether an application domain is owned by the specified contract.

Dispose()

Отменяет маркер времени жизни на контракте, без учета ввода.Revokes the lifetime token on a contract, regardless of input.

Dispose(Boolean)

Отменяет маркер времени жизни на контракте без учета ввода и дополнительно высвобождает управляемые ресурсы.Revokes the lifetime token on the contract regardless of input and optionally releases the managed resources.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
Finalize()

Освобождает ресурсы, связанные с экземпляром ContractHandle.Releases the resources associated with the ContractHandle instance.

GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Применяется к