TdxDashboard.OnViewerFormShow Event

Allows you to customize Dashboard Designer dialog form settings.

Declaration

property OnViewerFormShow: TdxBackendFormNotifyEvent read; write;

Remarks

Handle OnDesignerFormShow and OnViewerFormShow events to customize Dashboard Designer and Dashboard Viewer dialogs when displayed. You can change caption, dimensions, position, and other settings as demonstrated in the following code example: Modify Dashboard Viewer Form Settings.

Event Occurrence

The ShowViewer procedure raises the OnViewerFormShow event.

Event Parameters

The following parameters are available within an OnViewerFormShow event handler:

ASender

Provides access to the TdxDashboard component that raised the OnViewerFormShow event.

Tip

Cast the returned object (TObject) to the TdxDashboard class to access all public API members.

AForm

Provides access to the Dashboard Viewer dialog form. You can use this parameter to customize any dialog form settings.

Refer to the TdxBackendFormNotifyEvent procedural type description for detailed information on parameters accessible within an OnViewerFormShow event handler.

Code Example: Modify Dashboard Viewer Form Settings

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

Delphi

uses
  dxDashboard;  // Declares the TdxDashboard class
//...

procedure TMyForm.dxDashboard1ViewerFormShow(ASender: TObject; AForm: TForm);
begin
  AForm.Caption := 'My Dashboard Viewer';  // Changes the Dashboard Viewer 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;

C++

#include "dxDashboard.hpp"  // Declares the TdxDashboard class

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

void __fastcall TMyForm::dxDashboard1ViewerFormShow(TObject *ASender, TForm *AForm)
{
  AForm->Caption = "My Dashboard Viewer";  // Changes the Dashboard Viewer 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
}