Events fired to extensions implementing IExtension. Event args will vary by event. Note that EventBulkContext is normally available in any event's Event args, but only meaningful when a bulk operation is in process.

Namespace: NetQuarry
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)

Syntax

Copy

public enum ExtensionEvents

Public Enumeration ExtensionEvents

Members

Member name	Value	Description
CustomStart	1	The starting index for event ID's reserved for custom events. Custom events can be added for a particular application.
CustomEnd	9999	The ending index for event ID's reserved for custom events. Custom events can be added for a particular application.
MapperStart	10001	The starting index for events related to mappers. Any event here should have a virtual handler in MapperExtensionKernel.
MapperEnd	19999	The ending index for events related to mappers. Any event here should have a virtual handler in MapperExtensionKernel.
FieldButtonClick	10101	The field's button has been clicked.
FieldTest	10102	The field should execute it's self-test.
FieldBuildFilter	10103	The field is building a filter.
FieldAnomaly	10104	The field has an anomalous value the details of which are provided as FieldAnomalyArgs event args. A FieldAnomalyArgs object (which includes the FieldAnomaly) will be provided in the event args.
FieldAjaxSave	10105	A new field value has been sent back via an AJAX call. FieldAjaxSaveEventArgs are provided in the Event Args.
FieldCreateControl	10106	The field requires a WebControl and the field's CellTypes is Dynamic. For other CellTypes the control is created by the field object, but when the CellType is Dynamic this event is fired and it is expected that an extension will respond with the CellType and/or Control to use.
FieldConfirm	10107	The user has initiated an action that requires confirmation and the associated field has been configured to use a FieldConfirm event. A FieldConfirmArgs object will be provided in the event args.
RowCurrent	10201	The mapper has just positioned to a different record.
RowBeforeInsert	10202	The mapper is just about to insert an entire row into the database.
RowAfterInsert	10203	The mapper has just completed inserting an entire row into the database.
RowBeforeUpdate	10204	The mapper is just about to update an entire row in the database.
RowAfterUpdate	10205	The mapper has just completed updating an entire row in the database.
RowBeforeDelete	10206	The mapper is just about to delete an entire row from the database.
RowAfterDelete	10207	The mapper has just completed deleting an entire row from the database.
RowExecSQL	10208	The mapper is just about to execute a single SQL statement that is row-specific (e.g. executing an INSERT, UPDATE or DELETE statement).
RowSetDefaults	10209	The mapper is moving to a new record and has just completed populating defaults. Immediately following this event it will fire the RowCurrent event. The intent is to provide an opportunity for programmatically setting defaults to field values.
RowAjaxRequest	10210	An AJAX request was directed to this mapper. The mapper has been requeried on the requested RowKey and the extension should take appropriate action which might include returning a JSON response. AjaxRequestEventArgs are provided in the Event Args.
RowDrilldown	10211	Datasheet drilldown buttons are normally rendered as links to the same detail page with a different RowKey per link. However, when the DrilldownAttrs.FireDrilldownEvent bit is set, the drilldown button is rendered as a button that, when clicked, posts back the page causing the mapper to fire the RowDrilldown event. The event will be fired on a clone of the mapper positioned to the row that was clicked (per its RowKey). Typically an extension handling the RowDrilldown event will programmatically determine the drilldown target and call Navigate(String, String, String, String) or alter the RowDrilldownArgs values to specify a new target MOP and/or RowKey and allow the mapper to perform the custom navigation. If no action is performed by the extension then the mapper will perform the Application.Navigate using the same MOP and RowKey that it would have used had the FireDrilldownEvent not been set.
RowValidate	10212	This event is fired by WizSimpleImport (and possibly other import mechanisms) during a validate-only phase each time the import mapper has been populated with all data from the current import record and all built-in validation has been performed. RowValidateArgs are provided in the Event Args.
MapperAfterLoad	10307	The mapper's meta-data has been loaded, fields created, etc, but no field controls created. This is typically the only opportunity to alter field CellType programmatically for fields not specified as Dynamic. See MapperAfterLoad(IMapper, EAPEventArgs) for more information.
MapperBeforeLayout	10301	The mapper is just about to begin laying out the mapper's UI.
MapperAfterLayout	10302	The mapper has just begun laying out the mapper's UI.
MapperCommand	10303	A mapper command has been invoked providing EAPCommandEventArgs in the Event Args. See MapperCommand(IMapper, EAPCommandEventArgs) for more information.
MapperBeforeRequery	10304	The mapper is just about to requery its operational data.
MapperAfterRequery	10305	The mapper has just requeried its operational data.
MapperExecSQL	10306	The mapper is just about to execute a single SQL statement that is not row-specific (e.g. selecting the mappers operational data).
MapperBulkBeforeInsert	10331	The mapper has just started a bulk insert of records into the database.
MapperBulkAfterInsert	10332	The mapper has just comnpleted a bulk insert of records into the database.
MapperBulkBeforeUpdate	10333	The mapper has just started a bulk update of records in the database.
MapperBulkAfterUpdate	10334	The mapper has just completed a bulk update of records in the database.
MapperBulkBeforeDelete	10335	The mapper has just started a bulk delete of records from the database.
MapperBulkAfterDelete	10336	The mapper has just completed a bulk delete of records from the database.
MapperBuildFilter	10337	The mapper is about to build a filter.
MapperQueryError	10338	The mapper has encountered an error while opening the underlying query.
AuditInsert	10401	This is an appropriate time to audit an insert in the mapper.
AuditUpdate	10402	This is an appropriate time to audit an update in the mapper.
AuditDelete	10403	This is an appropriate time to audit a delete in the mapper.
AuditMessage	10405	Log a custom audit message entry providing EAPAuditMessageEventArgs in the Event Args.
AuditExport	10406	Log a custom audit export message entry providing EAPAuditExportEventArgs in the Event Args.
FileDownload	10501	File is being downloaded from a IField in a IMapper. Note that EAPFileDownloadEventArgs are provided in the Event Args.
ApplicationBeforeAuthenticate	20001	Fired just before the application calls Authenticate on the IAuthenticationProvider configured for the application.
ApplicationAfterAuthenticate	20002	Fired just after the application calls Authenticate on the IAuthenticationProvider configured for the application. Note that beginning with v4.5.2 AfterAuthenticateEventArgs are provided in the Event Args.
ApplicationAfterLoad	20003	Fired after the application is loaded and read for use.
ApplicationWakeUp	20004	Fired after the application is re-connected (WakeUp, WakeUp(WakeUpFlags)).
ApplicationOnPasswordChange	20005	Fired when the IAuthenticationProvider performs a password change
ApplicationBeforeLoadProfiles	20006	Fired before the IAuthenticationProvider loads the roles.
ApplicationBeforeShowReport	20007	Fired before a report is shown.
ApplicationBeforeSendMail	20008	Fired before an email address is sent
ApplicationAfterSendMail	20009	Fired after an email address is sent
ApplicationMailReceived	20010	Fired after an email is received by the parse API
ApplicationWebServiceRequest	20011	Fired when a web service request is received
ApplicationGetMailService	20012	Fired after the MailMessage has been prepared, but before the BeforeSendMail event. This gives the extension a chance to change the message or the mail service before the service used to send is constructed. You must set the ServiceName property and return DataChanged in order for the service to be changed.
ApplicationPageInit	20013	Fired during page initialization. Currently this is fired for all pages built from a standard IPageTemplate-implementing template. This includes the ConsoleTemplate, BootConsoleTemplate, WizTemplate, TabbedSubformTemplate, ExpandedSubformTemplate, and PopupDialogTemplate as well as other special-purpose templates. The event is fired at the end of the standard page template initialization, but before template-specific initialization. In essense this means that the event is fired mid-initialization and the extact state of the initialization will vary from template-type to template-type. Note that ApplicationPageArgs are provided in the Event Args. For HTML-only pages, the ApplicationPageHtml event may be fired instead.
ApplicationPageHtml	20014	Fired during page initialization for HTML-only pages. HTML-only pages include items generated in response to an AJAX request. And example of such a case is HelpTemplate items (e.g. ConsoleDetail_HelpTemplate) which are generated in response to a "hlptmpl" AJAX request. The event is fired after the platform has constructed the header and body HTML to be returned. This allows a handler to modify the header and/or body. A common use of this is to add application-specific script or css references to the header. Note that ApplicationPageHtmlArgs are provided in the Event Args. This event is NOT fired for pages built from a standard IPageTemplate-implementing template. For such, the ApplicationPageInit event is fired instead.
ApplicationAuthenticationFailed	20015	Fired when Authentication failed.
ApplicationWebhook	20016	Fired when an external webhook is received. Note that ApplicationWebhookArgs is provided in the Event Args. See Webhook(IAppContext, ApplicationWebhookArgs) for more information.
ApplicationAlert	20017	Fired when an an alert is about to be delivered to the user. Such alerts include user messages created using DisplayMessage(Alert) or one of its overloads. Note that ApplicationAlertArgs is provided in the Event Args. See Alert(IAppContext, ApplicationAlertArgs) for more information.
ApplicationMapperLoad	20018	Fired by a IMapper at the end of its Load, immediately following the mapper's MapperAfterLoad event. This provides the application with the opportunity to "hook" every mapper. One possible use would be to add a "global" extension to every mapper.
ApplicationBreadcrumbs	20019	Fired when a breadcrumb trail is being constructed to provide the application with an opportunity to construct a custom breadcrumb trail instead of the standard platform breadcrumb trail. Note that BreadcrumbsEventArgs are provided in the Event Args. See Breadcrumbs(IAppContext, BreadcrumbsEventArgs) for more information.
ApplicationBeginTwoFactorAuth	20020	Fired if a user is marked with two-factor authentication (TwoFactorAuth) AFTER the AfterLoad event (ApplicationAfterLoad).
WizardAfterPageLoad	30001	Fired when a wizard page is loaded. At the time this event is fired the wizard page has been loaded and added to the System.Web.UI.Page object. See WizardBeforePageLoad. Note that WizardPageEventArgs are provided in the Event Args. See WizardPageLoad(Object, WizardPageEventArgs) for more information.
WizardPageLoad	30001	Deprecated in favor of WizardAfterPageLoad for consistency in naming with WizardBeforePageLoad. See WizardPageLoad(Object, WizardPageEventArgs) for more information.
WizardNext	30002	Fired when the next button is clicked on a wizard. The most common reason for handling this event is to redirect navigation to another page within the wizard by setting the event's NextPage property. At the time of this event the parent's wizard's CurrentPage property is the projected destination page and the PrevPage is the page just departed. The WizardPage object will be the page being departed. Note that WizardPageEventArgs are provided in the Event Args. See also WizardPrev. See WizardNext(Object, WizardPageEventArgs) for more information.
WizardPrev	30003	Fired when the previous button is clicked on a wizard. The most common reason for handling this event is to redirect navigation to another page within the wizard by setting the event's NextPage property. At the time of this event the parent's wizard's CurrentPage property is the projected destination page and the PrevPage is the page just departed. The WizardPage object will be the page being departed. Note that WizardPageEventArgs are provided in the Event Args. See also WizardNext. See WizardPrev(Object, WizardPageEventArgs) for more information.
WizardFinish	30004	Fired when the finish button is clicked on a wizard. The event is fired just prior to the page's finish logic (typically a save operation of some kind) being executed. Note that WizardPageEventArgs are provided in the Event Args. See WizardFinish(Object, WizardPageEventArgs) for more information.
WizardCancel	30005	Fired when the cancel button is clicked on a wizard. The event is fired just prior to the page's cancel logic. Note that if CancelScriptOnClient is set then all cancel handling will be performed on the client, no postback will occur, and this event will not be fired. Note that WizardPageEventArgs are provided in the Event Args. See WizardCancel(Object, WizardPageEventArgs) for more information.
WizardDataExchange	30006	Fired at various stages in the page life-cycle when wizard page data is being transfered. WizardDataExchangeArgs are provided to identify what kind of data exchange is being performed. See WizardDataExchange(Object, WizardDataExchangeArgs) for more information.
WizardBeforePageLoad	30007	Fired when a wizard page is about to be loaded. At the time this event is fired the wizard page has not yet been loaded and added to the System.Web.UI.Page object, but it has been set up for loading. This means that the WizardPageEventArgs.WizardPage.UserData is available. The primary intent of this event is to provide access to the wizard page descriptor and UserData prior to the wizard page's mapper being loaded. See WizardAfterPageLoad. Note that WizardPageEventArgs are provided in the Event Args. See WizardBeforePageLoad(Object, WizardPageEventArgs) for more information.
WizardCommand	30008	Fired when the user clicks on a custom wizard command button. Wizard command buttons are specified by providing a menu navigator via the wizard page's PageCommands property and are placed after the standard wizard buttons (e.g. Previous, Next, etc.). Note that WizardCommandEventArgs are provided in the Event Args. See WizardCommand(IWizardTemplate, WizardCommandEventArgs) for more information.
WizardComplete	30009	Fired at the very end of the wizard invocation. This event is fired AFTER the WizardFinish event, the final WizardDataExchange event, the WizardBeforeFinalSave event, and the actual Save operation providing the ability to override the wizard's final page ContinueText or FinishScript. It also provide a good event from which to perform a custom navigation. Note that WizardCompleteEventArgs are provided in the Event Args. See WizardComplete(IWizardTemplate, WizardCompleteEventArgs) for more information.
WizardBeforeFinalSave	30010	Fired immediately following the final WizardDataExchange event, but before the actual Save operation, providing the ability for an extension to examine the fully-populated IMapper just prior to its Save operation being invoked and take action based on the mapper's data. The primary purpose of this event is to provide a final opportunity to cancel the save operation. See WizardBeforeFinalSave(IWizardTemplate, WizardFinalSaveEventArgs) for more information.
WizardPaneBeforeLayout	30101	Fired by a IWizContainer pane immediately prior to pane layout with WizContainerEventArgs provided in Event Args. See WizardPaneBeforeLayout(IWizContainerPane, WizContainerEventArgs) for more information.
WizardPaneMapperLoaded	30102	Fired on the IWizardTemplate when one of its PageElementInfo elements has completed the initial load of its IMapper with WizardEventArgs provided in Event Args. This generally provides the earliest access to the element's IMapper. Note that this event is fired for each element regardless of whether or not it is hosted in a IWizContainerPane. See WizardPaneMapperLoaded(IWizardTemplate, WizardEventArgs) for more information.
ConsolePaneBeforeLayout	31001	Fired by a IConsoleTemplate pane immediately prior to pane layout with ConsoleEventArgs provided in Event Args. See ConsolePaneBeforeLayout(IConsolePane, ConsoleEventArgs) for more information.
ConsolePaneBeforeBind	31002	Fired by a IConsoleTemplate pane immediately prior to BindPage(Page, Control, Boolean) with ConsoleEventArgs provided in Event Args. See ConsolePaneBeforeBind(IConsolePane, ConsoleEventArgs) for more information.
ConsolePaneBeforeRequery	31003	Fired by a IConsoleTemplate immediately prior to Requery(RequeryHints) with ConsoleEventArgs provided in Event Args. See ConsolePaneBeforeRequery(IConsolePane, ConsoleEventArgs) for more information.
ConsolePaneAfterRequery	31004	Fired by a IConsoleTemplate immediately following Requery(RequeryHints) with ConsoleEventArgs provided in Event Args. See ConsolePaneAfterRequery(IConsolePane, ConsoleEventArgs) for more information.
SchedulerNavigationComplete	31005	Fired when the scheduler navigation is complete (date or view change).
MailBeforeSend	40001	This event is fired when an email is about to be sent. Currently this event is fired only when the email is sent from the TemplateMailer, but in the future the event may originate from elsewhere. When fired from the TemplateMailer, the sender will be a IMapper object and the event args will be a MailEventArgs object.
MailAfterSend	40002	This event is fired when an email has been successfully sent. Note that since email is often sent asynchronously, success may signify only that the email was queued. In any case it does not indicate that the email has reached, or will reach, its designated recipient. Currently this event is fired only when the email is sent from the TemplateMailer, but in the future the event may originate from elsewhere. When fired from the TemplateMailer, the sender will be a IMapper object and the event args will be a MailEventArgs object.
PageCommand	50001	Fired on the page extensions when a page command (toolbar button, action menu) is clicked.
ApplicationMessageReceived	60001	This event is fired when an SMS message is received. An ApplicationMessageArgs object is provided as the event args.
ApplicationMessageStatus	60002	This event is fired when an SMS message status is received (e.g. delivered, sent, failed). An ApplicationMessageArgs object is provided as the event args.
ApplicationCallReceived	60003	This event is fired when a voice call is received. An ApplicationMessageArgs object is provided as the event args.
ApplicationPasswordChanged	60004	The password has been changed. Fired before the email is sent to the user. An ApplicationPasswordArgs object is provided as the event args.
ApplicationPasswordReset	60005	The password has been reset to a random value. Fired before the email is sent to the user. An ApplicationPasswordArgs object is provided as the event args.
ApplicationPasswordSend	60006	The password is about to be sent in cleartext via email. Fired before the email is sent to the user. An ApplicationPasswordArgs object is provided as the event args.
ApplicationVoiceDial	60007	This event is fired when a voice call is placed. An ApplicationVoiceArgs object is provided as the event args.
ApplicationVoiceStatus	60008	This event is fired when status messages are received from an ongoing call. An ApplicationVoiceArgs object is provided as the event args.
TemplatePluginPreRender	70001	This event is fired when a Plugin template is about to be rendered. See PluginPreRender(Template, PluginPreRenderEventArgs) for more information.
ZoomMeetingWebhook	80001	This event is fired when a Zoom meeting webhook request is received. See ZoomMeetingWebhook(IAppContext, ZoomMeetingEventArgs) and ZoomMeetingEventArgs for more information.
ExtensionCommand	100001	This event is fired when an extension is to be issued a ExtensionCmd and is intended for communicating with any extension type. An ExtensionCommandArgs object is provided as the event args. Extension commands are intended for internal use and at this time no dedicated virtual method for overriding is provided in any of the standard extension base classes. In the future such a method may be provided.

Remarks

Extension events fall into the following categories:

Custom events - Events reserved for custom use with values between CustomStart and CustomEnd (inclusive).
Field events - Events related to a particular IField and fired against the field's IMapper mapper extensions.
Mapper events - Events related to an IMapper as a whole and fired against the mapper's extensions.
Row events - Events related to a particular row (record) in an IMapper and fired against the mapper's extensions.
Audit events - Events related to auditing an IMapper and fired against the mapper's extensions.
File events - Events related to a file and fired against the related IMapper extensions.
Scheduler events - Events related to a scheduler (calendar) page and fired against the PageInfo extensions.
Mail events - Events related to email. Currently all mail events are fired against the related IMapper extensions.
Page events - Events related to a page and fired against the PageInfo extensions.
Application events - Events related to an application and fired against the IAppContext extensions.
Wizard events - Events related to a wizard page and fired against the PageInfo extensions.
Console events - Events related to a console page and fired against the PageInfo extensions.
Template events - Events related to a Template and fired against the template's extension.
Extension events - Events directed to an extension itself.

Extensions handling these events usually derive from the appropriate base class according to the type of extension the event is fired against:

Mapper - MapperExtensionKernel or TypedMapperExtensionT for generated typed mappers.
Page - PageExtensionBase.
Application - ApplicationExtensionBase.
Template - TemplateExtensionBase.
Any/Other - ExtensionBase.

Remarks

You can add multiple extensions on a particular object. If an object does have multiple extensions, then extension events will be fired against all the extensions in order of decreasing Priority (highest priority first). Extensions are loaded into, and fired through, an object's Extensions collection. See Extensions for more information about event handling.

Reference

NetQuarry Namespace