Click or drag to resize

EAPCommandEventArgs Class

Holds event arguments for the MapperCommand event.
Inheritance Hierarchy

Namespace:  NetQuarry
Assembly:  EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
Syntax
public class EAPCommandEventArgs : EAPEventArgs

The EAPCommandEventArgs type exposes the following members.

Constructors
  NameDescription
Public methodEAPCommandEventArgs
Constructs a EAPCommandEventArgs object
Top
Properties
  NameDescription
Public propertyBulkContext
Gets/sets the context of the current bulk operation, if any. If this event is part of a bulk operation, this is the context of that bulk operation. If this event is not part of a bulk operation, this context will be null.
(Inherited from EAPEventArgs.)
Public propertyCommandName
Gets/Sets the command's name
Public propertyErrorDeveloperMessage
An optional, developer-specific error message. This will be logged to the Devlog and xot_request_log, but only displayed in user error messages when the user is identified as IsDeveloper.
(Inherited from EAPEventArgs.)
Public propertyCode exampleErrorMessage
Sets the extention's error message for this event.
(Inherited from EAPEventArgs.)
Public propertyErrorOptions
Options used to specify additional characteristics about an exception.
(Inherited from EAPEventArgs.)
Public propertyEvent
Gets/Sets the event that is currently executing.
(Inherited from EAPEventArgs.)
Public propertyGroupingKey
When the event is being fired from an item with Grouper, this will be the key for the field used for grouping in the rendered list. Does not apply to commands located elsewhere. Use GroupingValue to determine the value used to group.
Public propertyGroupingRawValue
When the event is being fired from an item with Grouper, this will be the raw value of the grouping field for the invoked command. Does not apply to commands located elsewhere. Use GroupingKey to determine the field used to group.
Public propertyGroupingValue
When the event is being fired from an item with Grouper, this will be the value of the grouping field for the invoked command. Does not apply to commands located elsewhere. Use GroupingKey to determine the field used to group.
Public propertyParams
Gets/sets a set of name/value pairs in the form of a QueryString.
Public propertyResult
Gets/Sets the result to return from the event.
(Inherited from EAPEventArgs.)
Public propertyRowKey
The RowKey of the record on which the command is to be performed. Typically this value is provided only RowMenu commands. For other commands, the RowKey(s) of the records on which to act may be obtained via the SelectedKeys command.
Public propertySelectedKeys
Gets/sets the list of selected row keys on which the command is to be performed. Currently this list is provided only for limited situations and therefore should be checked for null. If null, the RowKey(s) of the records on which to act may typically be obtained via the SelectedKeys command.
Top
Methods
  NameDescription
Public methodCode exampleCancel
Sets the extention's result code and error message for this event. The result code is set to ExtResultsExtResults.Cancel.
(Inherited from EAPEventArgs.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodCode exampleError(String)
Sets the extention's result code and error message for this event. The result code is set to Error. Use Error(String, String, ExceptionOptions) to include an additional developer message and/or options.
(Inherited from EAPEventArgs.)
Public methodCode exampleError(String, String, ExceptionOptions)
Sets the extention's result code and error message for this event with an optional developer-specific error message and options. The result code is set to Error.
(Inherited from EAPEventArgs.)
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
Serves as a hash function for a particular type.
(Inherited from Object.)
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 String that represents the current Object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodEqualValue
Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.)
Top
See Also