ExecSQLArgs Class

Constructor.

Constructor for basic operations. Use ExecSQLArgs(String, String, ExecSQLArgsExecuteStatementType) for more nuanced statement types.

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.

If a DataTable is provided, it will be used by the mapper instead of performing the query. The structure for the DataTable can be obtained from the mapper by calling Exec(MapperExecCmds, Int32, Object) with the RetrieveDataTable command. Note that currently the returned data is used only for the Aggregate statement and is ignored for all other statement types.

Only the mapper's aggregate data can be provided during the MapperExecSQL event. To provide the primary data, set Data during the MapperBeforeRequery event.

A flag indicating whether the object's SQL has been modified.

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.

Gets/sets the RecordCount for the mapper. This property may be set by an extension in response to a MapperExecSQL event when the event StatementType is RecordCount.

Gets/Sets the result to return from the event.

If you change the SQL during the MapperExecSQL event you should ALWAYS set this. It must be set by the extension for Aggregate type queries or the change will be ignored.

Gets/sets the Filter used during row requery handling. During RowRequery, there are no filters in the mapper's filters collection. Only the row key filter is appended to the executed SQL

The SQL to be executed. Note: Setting this value will cause the Dirty flag to be set.

Returns the statement type (e.g. Insert, Update, Delete, Select) from ExecSQLArgsExecuteStatementType.

Returns the name of the table for this SQL statement.

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.

Preferred method to change the SQL from an extension

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.