Export (0) Print
Expand All

PolicyList Class

Manages a list of loaded policies for a set of pending changes.

System.Object
  Microsoft.TeamFoundation.VersionControl.Client.PolicyList

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

public class PolicyList : IDisposable

The PolicyList type exposes the following members.

  NameDescription
Public methodPolicyListInitializes the policy list so that it can access the policy information on the server.
Top

  NameDescription
Public propertyEvaluationStateGets the overall state of the policy list.
Public propertyFailuresGets the array of current policy failures.
Public propertyPendingCheckinSets the pending check-in object with which this policy list is associated.
Public propertyPolicyCountGets the number of policies in this list.
Top

  NameDescription
Public methodDisposeClean up the object when it is no longer required.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodEvaluateEvaluates the policies for the current list of pending changes.
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 the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodLoadPoliciesLoads the currently applicable policies.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodReloadAndEvaluateReloads the policies and evaluates the policies for the current list of pending changes.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventPolicyEvaluationStateChangedAn event that occurs when the policy failure list is updated asynchronously. It does not occur when the Evaluate method is called.
Public eventPolicyStateChangedAn event that occurs when the policy failure list is updated asynchronously. It does not occur when the Evaluate method is called.
Top

It can evaluate the policies on demand, provide a list of failures, and provide an overall evaluate state summary.

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