CancelEventArgs ClassCognex VisionPro 9.21

This class provides a boolean argument to control the optional cancellation of an action during event processing. Unlike most event argument classes which simply deliver information to the subscriber, this argument class allows two-way communication. Specifically, a recipient of an event notification with an instance of this argument class may optionally set the Cancel property to true, thereby communicating to the source of the event that the action should be cancelled.

Inheritance Hierarchy

System Object
  System EventArgs
    Cognex.Vision EventArgs
      Cognex.Vision CancelEventArgs
        Cognex.Vision CancelChangingStringEventArgs

Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.21.0.0
Syntax

public class CancelEventArgs : EventArgs, 
	IObject

The CancelEventArgs type exposes the following members.

Constructors

  NameDescription
Public methodCancelEventArgs 

Construct an instance of this class with the value of Cancel set by default to false.

Public methodCancelEventArgs(Boolean)

Construct an instance of this class and set the Cancel property to the supplied value.

Top
Methods

  NameDescription
Public methodEquals
Compares the equality of this object with another.
(Overrides EventArgs Equals(Object).)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Returns the hash code of this object.
(Overrides EventArgs GetHashCode .)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString

Returns a human readable string that represents the object.

(Overrides Object ToString .)
Top
Operators

  NameDescription
Public operatorStatic memberEquality
Compares the equality of two CancelEventArgs objects.
Public operatorStatic memberInequality
Compares the inequality of two CancelEventArgs objects.
Top
Fields

  NameDescription
Protected field_interopHandle
Top
Properties

  NameDescription
Public propertyCancel
Get

Get the value of the Cancel property.

Public propertyHandle (Overrides EventArgs Handle.)
Top
See Also