EAPPageCommandEventArgs Class

Constructs a new instance of the object

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.

Gets/Sets the command's name

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.

Sets the extention's error message for this event.

Options used to specify additional characteristics about an exception.

Gets/Sets the event that is currently executing.

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.

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.

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.

The main mapper object (this is different from the Mapper only in PaneNavigation)

The main mapper PageElement (this is different from the PageElement only in PaneNavigation)

The primary IMapper for this page firing the event. May be null.

The PageElementInfo for the current page element, if any (may be null). Generally applies only to PageElement-specific events (e.g. pane events).

The PageInfo for the page firing the event.

Gets/sets a set of name/value pairs in the form of a QueryString.

The primary renderer control for the page or PageElement.

Gets/Sets the result to return from the event.

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.

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.

Sets the extention's result code and error message for this event. The result code is set to ExtResultsExtResults.Cancel.

Determines whether the specified Object is equal to the current Object.

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.

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.

Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.

Serves as a hash function for a particular type.

Gets the Type of the current instance.

Creates a shallow copy of the current Object.

Returns a String that represents the current Object.

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.