This documentation is archived and is not being maintained.
PolicyBase Class
Visual Studio 2013
Base class to inherit for a new check-in policy.
System::Object
Microsoft.TeamFoundation.VersionControl.Client::PolicyBase
Microsoft.TeamFoundation.Build.Controls::BuildPolicy
Microsoft.TeamFoundation.VersionControl.Controls::WorkItemPolicy
Microsoft.TeamFoundation.VersionControl.Client::PolicyBase
Microsoft.TeamFoundation.Build.Controls::BuildPolicy
Microsoft.TeamFoundation.VersionControl.Controls::WorkItemPolicy
Namespace: Microsoft.TeamFoundation.VersionControl.Client
Assembly: Microsoft.TeamFoundation.VersionControl.Client (in Microsoft.TeamFoundation.VersionControl.Client.dll)
The PolicyBase type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | CanEdit | Gets a flag that describes whether this policy is configurable. |
![]() | Description | Gets the description of this policy. |
![]() | Disposed | Returns true if this object has been disposed. |
![]() | InstallationInstructions | Gets or sets textual instructions about how the policy can be installed on a computer. |
![]() | PendingCheckin | Get an object that represents the pending changes part of the pending checkin. |
![]() | Type | Gets the name of this policy. |
![]() | TypeDescription | Gets the description of this kind of policy. |
| Name | Description | |
|---|---|---|
![]() | Activate | Called if the user double-clicks on a policy failure. |
![]() | DisplayHelp | Displays a Help dialog box that is associated with the policy failure. |
![]() | Dispose | Disposes this object. |
![]() | Edit | Shows a configuration dialog box to the user to specify options for the check-in policy. |
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | Evaluate | Performs the policy evaluation. |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetAssemblyName | Only 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. |
![]() | GetBinaryFormatter | Only 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). |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | Initialize | Initializes the specified pending check-in. |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | OnPolicyStateChanged | Fire the event to notify of a change in policy state. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
Show:
