Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFCaseCancelEventArgs Class

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFCaseCancelEventArgs Class
Provides data for the before AFCase action events.

Inheritance Hierarchy

SystemObject
  SystemEventArgs
    System.ComponentModelCancelEventArgs
      OSIsoft.AF.AnalysisAFCaseCancelEventArgs

Namespace:  OSIsoft.AF.Analysis
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public sealed class AFCaseCancelEventArgs : CancelEventArgs, 
	IEquatable<AFCaseCancelEventArgs>
Public NotInheritable Class AFCaseCancelEventArgs
	Inherits CancelEventArgs
	Implements IEquatable(Of AFCaseCancelEventArgs)

Dim instance As AFCaseCancelEventArgs
public ref class AFCaseCancelEventArgs sealed : public CancelEventArgs, 
	IEquatable<AFCaseCancelEventArgs^>
[<SealedAttribute>]
type AFCaseCancelEventArgs =  
    class
        inherit CancelEventArgs
        interface IEquatable<AFCaseCancelEventArgs>
    end

The AFCaseCancelEventArgs type exposes the following members.

Constructors

  NameDescription
Public method
AFCaseCancelEventArgs
Initializes a new instance of the AFCaseCancelEventArgs class for an AFCase action.

Properties

  NameDescription
Public property
Action
Gets an action that specifies what caused the event to be raised.
Public property
Cancel
Gets or sets a value indicating whether the event should be canceled.
(Inherited from CancelEventArgs.)

Methods

  NameDescription
Public method
Equals(Object)
Determines whether the specified Object is equal to the current object.
(Overrides ObjectEquals(Object).)
Public method
Equals(AFCaseCancelEventArgs)
Indicates whether the current object is equal to another object of the same type.
Public method
GetHashCode
Gets the hash code for this instance of the object which is suitable for use in hashing algorithms and data structures like a hash table.
(Overrides ObjectGetHashCode.)
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
ToString
Returns a String that represents the current object.
(Overrides ObjectToString.)

Operators

  NameDescription
Public operatorStatic member
Equality
The equality operator (==) compares its operands to determine if they are equal.
Public operatorStatic member
Inequality
The inequality operator (!=) compares its operands to determine if they are not equal.

Remarks

These arguments are used when generating a before AFCase events that can be canceled.

Version Information

AFSDK


See Also

TitleResults for “How to create a CRG?”Also Available in