Click or drag to resize

ExecSQLArgs Properties

The ExecSQLArgs type exposes the following members.

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 propertyData
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.

Public propertyDirty
A flag indicating whether the object's SQL has been modified.
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 propertyRecordCount
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.
Public propertyResult
Gets/Sets the result to return from the event.
(Inherited from EAPEventArgs.)
Public propertyReturnStatementType
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.
Public propertyRowRequeryFilter
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
Public propertySQL
The SQL to be executed. Note: Setting this value will cause the Dirty flag to be set.
Public propertyStatementType
Returns the statement type (e.g. Insert, Update, Delete, Select) from ExecSQLArgsExecuteStatementType.
Public propertyTableName
Returns the name of the table for this SQL statement.
Top
See Also