PolicyBase Class

Article
2012-08-13

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

Inheritance Hierarchy

System.Object
Microsoft.TeamFoundation.VersionControl.Client.PolicyBase

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

Syntax

'Declaration
<SerializableAttribute> _
Public MustInherit Class PolicyBase _
    Implements IPolicyDefinition, IPolicyEvaluation, IDisposable

[SerializableAttribute]
public abstract class PolicyBase : IPolicyDefinition, 
    IPolicyEvaluation, IDisposable

[SerializableAttribute]
public ref class PolicyBase abstract : IPolicyDefinition, 
    IPolicyEvaluation, IDisposable

[<AbstractClass>]
[<SerializableAttribute>]
type PolicyBase =  
    class
        interface IPolicyDefinition
        interface IPolicyEvaluation
        interface IDisposable
    end

public abstract class PolicyBase implements IPolicyDefinition, IPolicyEvaluation, IDisposable

The PolicyBase type exposes the following members.

Constructors

	Name	Description
	PolicyBase

Top

Properties

	Name	Description
	CanEdit	Gets a flag that describes whether this policy is configurable.
	Description	Gets the description of this policy.
	Disposed
	InstallationInstructions	Gets or sets textual instructions about how the policy can be installed on a computer.
	PendingCheckin
	Type	Gets the name of this policy.
	TypeDescription	Gets the description of this type of policy.

Top

Methods

	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.)
	GetHashCode	Serves as a hash function for a particular type. (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
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	PolicyStateChanged	Occurs when the state of the policy is changed.

Top

Thread Safety

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

Share via