Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

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, 
	IPolicyEvaluation, IDisposable

The PolicyBase type exposes the following members.

Protected methodPolicyBase

Public propertyCanEditGets a flag that describes whether this policy is configurable.
Public propertyDescriptionGets the description of this policy.
Protected propertyDisposed
Public propertyInstallationInstructionsGets or sets textual instructions about how the policy can be installed on a computer.
Protected propertyPendingCheckin
Public propertyTypeGets the name of this policy.
Public propertyTypeDescriptionGets the description of this type 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 methodGetHashCodeServes as a hash function for a particular type. (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 methodOnPolicyStateChanged
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.

Community Additions

© 2015 Microsoft