CancelChangingStringEventArgs ClassCognex VisionPro 9.20

This class provides arguments for a cancellable change to a string. These arguments include a copy of the old string value as well as a copy of the new string value. In addition, these arguments include a reference to an optional exception to be thrown should cancellation be activated. Cancellation is activated when the base class Cancel property is set to true.

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.10.0.0
Syntax

public sealed class CancelChangingStringEventArgs : CancelEventArgs, 
	IObject

The CancelChangingStringEventArgs type exposes the following members.

Constructors

  NameDescription
Public methodCancelChangingStringEventArgs

Construct an instance of this class with the specified values for the old and new strings.

Top
Methods

  NameDescription
Public methodEquals
Compares the equality of this object with another.
(Overrides CancelEventArgs Equals(Object).)
Public methodGetHashCode
Returns the hash code of this object.
(Overrides CancelEventArgs GetHashCode .)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString

Returns a human readable string that represents the object.

(Overrides CancelEventArgs ToString .)
Top
Operators

  NameDescription
Public operatorStatic memberEquality
Compares the equality of two CancelChangingStringEventArgs objects.
Public operatorStatic memberInequality
Compares the inequality of two CancelChangingStringEventArgs objects.
Top
Properties

  NameDescription
Public propertyCancel
Get

Get the value of the Cancel property.

(Inherited from CancelEventArgs.)
Public propertyExceptionToThrow
Get

Get the exception that is to be thrown should the action be cancelled. This may be null.

Public propertyHandle (Inherited from CancelEventArgs.)
Public propertyNewValue

Get the new string value that will be assigned unless the action is cancelled.

Public propertyOldValue

Get the old string value that was in effect when the event was raised.

Top
See Also