Back to Devexpress

TdxBackendFormNotifyEvent Type

vcl-dxbackend-8e693f89.md

latest4.2 KB
Original Source

TdxBackendFormNotifyEvent Type

The procedural type for dialog-related events in ExpressDashboards and ExpressReports.

Declaration

delphi
TdxBackendFormNotifyEvent = procedure(ASender: TObject; AForm: TForm) of object;

Parameters

NameTypeDescription
ASenderTObject

Provides access to the component that raised the dialog-related event.

Tip

You need to cast the parameter value to the TdxDashboardControl or TdxReport class (depending on the actual parent component type) to access all public API members.

| | AForm | TForm |

Provides access to the target dialog form.

You can customize any dialog form settings (for example, change caption, dimensions, and position).

|

Remarks

Dialog form-related events allow you to customize end-user dialogs in ExpressDashboards and ExpressReports-powered applications.

Code Example: Modify Dashboard Designer Form Settings

The following code example demonstrates an OnDesignerFormShow event handler that modifies caption, dimensions, and position of the Dashboard Designer dialog when it is displayed:

delphi
uses
  dxDashboard.Control; // Declares the TdxDashboardControl component
//...

procedure TMyForm.dxDashboardControl1DesignerFormShow(ASender: TObject; AForm: TForm);
begin
  AForm.Caption := 'My Dashboard Designer'; // Changes the Dashboard Designer form caption
  AForm.WindowState := wsNormal; // Switches from maximized to the normal form state
  AForm.Position := poScreenCenter; // Centers the dialog on the screen
  AForm.Width := 1200; // Specifies the dialog width
  AForm.Height := 800; // Specifies the dialog height
end;
cpp
#include "dxDashboard.Control.hpp" // Declares the TdxDashboardControl component

// Add the following linker directive to the corresponding CPP source file:
#pragma link "dxDashboard.Control" // Required to use dxDashboard.Control.hpp declarations
// ...

void __fastcall TMyForm::dxDashboardControl1DesignerFormShow(TObject *ASender, TForm *AForm)
{
  AForm->Caption = "My Dashboard Designer"; // Changes the Dashboard Designer form caption
  AForm->WindowState = wsNormal; // Switches from maximized to the normal form state
  AForm->Position = poScreenCenter; // Centers the dialog on the screen
  AForm->Width = 1200; // Specifies the dialog width
  AForm->Height = 800; // Specifies the dialog height
}

Direct TdxBackendFormNotifyEvent Type References

The following events reference the TdxBackendFormNotifyEvent procedural type:

TdxDashboardControl.OnDesignerFormShowAllows you to customize Dashboard Designer dialog form settings.TdxDashboardControl.OnViewerFormShowAllows you to customize Dashboard Viewer dialog form settings.TdxReport.OnDesignerFormShowAllows you to customize Report Designer dialog form settings.TdxReport.OnViewerFormShowAllows you to customize Report Viewer dialog form settings. See Also

TdxDashboardControlNotifyEvent Procedural Type

TdxReportNotifyEvent Procedural Type

dxBackend Unit