PolicyList Class
Manages a list of loaded policies for a set of pending changes.
Inheritance Hierarchy
System.Object
Microsoft.TeamFoundation.VersionControl.Client.PolicyList
Namespace: Microsoft.TeamFoundation.VersionControl.Client
Assembly: Microsoft.TeamFoundation.VersionControl.Client (in Microsoft.TeamFoundation.VersionControl.Client.dll)
Syntax
'Declaration
Public Class PolicyList _
Implements IDisposable
public class PolicyList : IDisposable
public ref class PolicyList : IDisposable
type PolicyList =
class
interface IDisposable
end
public class PolicyList implements IDisposable
The PolicyList type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
PolicyList | Initializes the policy list so that it can access the policy information on the server. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
EvaluationState | Gets the overall state of the policy list. |
|
Failures | Gets the array of current policy failures. |
|
PendingCheckin | Sets the pending check-in object with which this policy list is associated. |
|
PolicyCount | Gets the number of policies in this list. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Dispose | Clean up the object when it is no longer required. |
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
Evaluate | Evaluates the policies for the current list of pending changes. |
.gif "Protected method") |
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.) |
|
LoadPolicies | Loads the currently applicable policies. |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
ReloadAndEvaluate | Reloads the policies and evaluates the policies for the current list of pending changes. |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
PolicyEvaluationStateChanged | An event that occurs when the policy failure list is updated asynchronously. It does not occur when the Evaluate method is called. |
|
PolicyStateChanged | An event that occurs when the policy failure list is updated asynchronously. It does not occur when the Evaluate method is called. |
Top
Remarks
It can evaluate the policies on demand, provide a list of failures, and provide an overall evaluate state summary.
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.