This documentation is archived and is not being maintained.

PolicyBase Class

Base class to inherit for a new check-in policy.

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

public abstract class PolicyBase : IPolicyDefinition, 
	IPolicyCompatibility, IPolicyEvaluation, IDisposable

The PolicyBase type exposes the following members.

Protected methodPolicyBaseInitializes a new instance of the PolicyBase class.

Public propertyCanEditGets a flag that describes whether this policy is configurable.
Public propertyDescriptionGets the description of this policy.
Protected propertyDisposedReturns true if this object has been disposed.
Public propertyInstallationInstructionsGets or sets textual instructions about how the policy can be installed on a computer.
Protected propertyPendingCheckinGet an object that represents the pending changes part of the pending checkin.
Public propertyTypeGets the name of this policy.
Public propertyTypeDescriptionGets the description of this kind of policy.

Public methodActivateCalled if the user double-clicks on a policy failure.
Public methodDisplayHelpDisplays a Help dialog box that is associated with the policy failure.
Public methodDisposeDisposes this object.
Public methodEditShows a configuration dialog box to the user to specify options for the check-in policy.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodEvaluatePerforms the policy evaluation.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetAssemblyNameOnly override this for backward compatibility where you want to 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 methodGetBinaryFormatterOnly override this 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 compatibility for a checkin policy that has been moved to another assembly).
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeInitializes the specified pending check-in.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnPolicyStateChangedFire the event to notify of a change in policy state.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Public eventPolicyStateChangedOccurs when the state of the policy is changed.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.