This documentation is archived and is not being maintained.

IPolicyCompatibility Interface

This interface is used for backward compatibility for checkin policies that have been moved to new types or assemblies.

Namespace:  Microsoft.TeamFoundation.VersionControl.Client
Assembly:  Microsoft.TeamFoundation.VersionControl.Client (in Microsoft.TeamFoundation.VersionControl.Client.dll)

public interface IPolicyCompatibility : IPolicyDefinition

The IPolicyCompatibility type exposes the following members.

Public propertyCanEditGets a flag that describes whether this policy includes configuration user interface (UI). (Inherited from IPolicyDefinition.)
Public propertyDescriptionGets a description of the behavior of this policy instance. (Inherited from IPolicyDefinition.)
Public propertyInstallationInstructionsGets a message that is displayed if the policy appears not to be installed. (Inherited from IPolicyDefinition.)
Public propertyTypeGets the type of the policy. (Inherited from IPolicyDefinition.)
Public propertyTypeDescriptionGets a description of the policy type. (Inherited from IPolicyDefinition.)

Public methodEditDisplays a dialog box to allow user to configure the properties of the policy. (Inherited from IPolicyDefinition.)
Public methodGetAssemblyNameUsed for backward compatibility where you must specify a different assembly name for the checkin policy in order to maintain backward compatibility with a previously released version of the checkin policy.
Public methodGetBinaryFormatterThis is necessary if you want to create a new BinaryFormatter and hook into the serialization process for backward compatibility (e.g., you want to set the Binder property on the formatter to handle compat for a checkin policy that has been moved to another assembly). If you do not want to hook into the serialization process, just return new BinaryFormatter().