Team Development with Visual Studio Team Foundation Server

example policy ensures that developers supply check-in comments whenever they check
in a file.
Before You Begin
Note that, to create a check-in policy, you must have the Manipulate security settings
permission set to Allow.
Summary of Steps
• Step 1 – Create and Build a Custom Policy Class
• Step 2 – Register the Custom Policy in the Windows Registry
• Step 3 – Apply the Custom Policy
• Step 4 – Validate the Custom Policy
Step 1 – Create and Build a Custom Policy Class
In this initial step, you create a custom policy class by deriving from the PolicyBase base
class in the Microsoft.TeamFoundation.VersionControl.Client namespace. By
deriving from this base class, your class implements the IPolicyDefinition and
IPolicyEvaluation interfaces. The example policy code below forces a developer to
supply check-in comments whenever he or she checks in a source file.
1. Use Visual Studio to create a new Visual C#® class library project.
2. Add an assembly reference to System.Windows.Forms.dll. You use this assembly to
display message boxes.
3. Add an assembly reference to
Microsoft.TeamFoundation.VersionControl.Client.dll. By default, this is installed
in the following folder:
\Program Files\Visual Studio 2005 Team Foundation Server\Tools
4. Replace your skeleton class code implementation with the following source. Note that
the class derives from the PolicyBase base class and is marked as serializable.
using System;
using System.Windows.Forms;
using Microsoft.TeamFoundation.VersionControl.Client;
[Serializable]
public class CheckForCommentsPolicy : PolicyBase
{
public override string Description
{
get { return "Remind users to add meaningful comments to their checkins"; }
}
// This is a string that is stored with the policy definition on the source
// control server. If a user does not have the policy plug-in installed, this string
// is displayed. You can use this to explain to the user how they should
// install the policy plug-in.
public override string InstallationInstructions
{
get { return "To install this policy, read InstallInstructions.txt."; }
}