ActiveReports 6 Online Help Send comments on this topic.
Customize the Viewer Control
See Also
ActiveReports 6 > ActiveReports User Guide > How To > Customize, Localize and Deploy > Customize the Viewer Control

Glossary Item Box

ActiveReports includes a control to view report output in custom preview forms. The viewer allows developers to modify the toolbars or add custom menu commands to the preview form.

To create a basic preview form

  1. Open a new Windows Forms project in Visual Studio and size the form according to your needs.
  2. From the Visual Studio toolbox, drag the Viewer control onto the form. If you have not added the viewer to the toolbox, see Adding ActiveReports Controls for more information.

  3. In the Properties window, set the Dock property to Fill.
  4. From the Project menu, select Add New Item.
  5. Select ActiveReports 6 File and click the Add button.
  6. Double-click in the title bar of the form to create a Form Load event.
  7. Add the following code to run the report and display the resulting document in the viewer.

    ShowTo write the code in Visual Basic.NET

    Visual Basic.NET code. Paste INSIDE the Form Load event. Copy Code
    Dim rpt as new NewActiveReport1
rpt.Run()
Viewer1.Document = rpt.Document

    ShowTo write the code in C#

    C# code. Paste INSIDE the Form Load event. Copy Code
    ActiveReport1 rpt = new ActiveReport1();
rpt.Run();
viewer1.Document = rpt.Document;
  8. Press F5 to run the project.

To use split windows on the viewer control

  1. With the project running, click the splitter control and drag downward.
  2. When the viewer is split into two sections, report layouts can be examined and report pages can be compared easily.

To add a custom print button to the viewer control

  1. Add a second Windows Form to the project created above and name it frmPrintDlg.
  2. Add a label to frmPrintDlg and change the Text property to This is the custom print dialog.
  3. Add a button to frmPrintDlg and change the Text property to OK.
  4. Back on the viewer form, double-click the title bar of the form to create a Form Load event.
  5. Add the following code to the Form Load event to remove the default print button and add your own.

    ShowTo write the code in Visual Basic.NET

    Visual Basic.NET code. Paste INSIDE the Form Load event. Copy Code
    ' Remove the default print button
Me.Viewer1.Toolbar.Tools.RemoveAt(2)
' Create and add the custom button
Dim btn As New DataDynamics.ActiveReports.Toolbar.Button()
btn.Caption = "MyPrint"
btn.ToolTip = "Custom Print Button"
btn.ImageIndex = 1
btn.ButtonStyle = DataDynamics.ActiveReports.Toolbar.ButtonStyle.TextAndIcon
btn.Id = 333
Me.Viewer1.Toolbar.Tools.Insert(2, btn)

    ShowTo write the code in C#

    C# code. Paste INSIDE the Form Load event. Copy Code
    // Remove the default printer button
this.viewer1.Toolbar.Tools.RemoveAt(2);
// Create and add the custom button
DataDynamics.ActiveReports.Toolbar.Button btn = new DataDynamics.ActiveReports.Toolbar.Button();
btn.Caption = "MyPrint";
btn.ToolTip = "Custom Print Button";
btn.ImageIndex = 1;
btn.ButtonStyle = DataDynamics.ActiveReports.Toolbar.ButtonStyle.TextAndIcon;
btn.Id = 333;
this.viewer1.Toolbar.Tools.Insert(2,btn);
  6. Add the following code to the Viewer ToolClick event to display frmPrintDlg when the custom print button is clicked.

    ShowTo write the code in Visual Basic.NET

    1. At the top left of the code view of the viewer form, click the drop-down arrow and select (YourReportName Events).
    2. At the top right of the code window, click the drop-down arrow and select ToolClick. This creates an event-handling method for the viewer's ToolClick event.
    3. Add code to the handler to display frmPrintDlg when the custom print button is clicked.
    Visual Basic.NET code. Paste INSIDE the Viewer ToolClick event. Copy Code
    ' Capture the new tool's click to show the dialog
If e.Tool.Id = 333 Then
    Dim dlg As New frmPrintDlg()
    dlg.ShowDialog(Me)
End If

    ShowTo write the code in C#

    1. Click the viewer on the form to select it.
    2. Click the events icon in the Properties Window to display available events for the viewer.
    3. Double-click ToolClick. This creates an event-handling method for the viewer's ToolClick event.
    4. Add code to the handler to display frmPrintDlg when the custom print button is clicked.
    C# code. Paste INSIDE the Viewer ToolClick event. Copy Code
    // Capture the new tool's click to show the dialog
if(e.Tool.Id == 333)
{
   frmPrintDlg dlg = new frmPrintDlg();
   dlg.ShowDialog(this);
}
  7. Press F5 to run the project and see the custom MyPrint button on the viewer.

See Also