ActiveReports allows Bookmarks to be easily set up and used in simple reports by adding code to the Detail_Format event of the report.

This walkthrough illustrates how to set up and use Bookmarks in a simple report.

This walkthrough is split up into the following activities:

• Adding an ActiveReport to a Visual Studio project
• Connecting the report to a data source
• Adding controls to the report to contain data
• Adding code to the Detail Format event to set up bookmarks
• Viewing the report 
• Viewing the Bookmarks collection with the report
• Adding special bookmarks at run time

To complete the walkthrough, you must have access to the Northwind database.
A copy is located at C:\Program Files\Data Dynamics\ActiveReports for .NET 3.0\Data\NWIND.MDB.

When you have completed this walkthrough, you will have a report that looks similar to the following.

Adding an ActiveReport to a Visual Studio project

To add an ActiveReport to your project

1. Open a new project in Visual Studio.
2. From the Project menu, select Add New Item.
3. Select ActiveReports 3.0 File and rename the file rptBookmarks.
4. Click Open.

Connecting the report to a data source

To connect the report to a data source

1. Click on the gray report DataSource icon in the Detail section to open the report DataSource dialog.
2. Select the "OLE DB" tab.
3. Click on Build.
4. Select Microsoft Jet 4.0 OLE DB Provider and click Next.
5. Click the ellipsis button to browse for the access path to the Northwind database. Click Open once you have selected the appropriate access path.
6. Click OK to continue.
7. In the Query field, type "Select * from categories inner join products on categories.categoryid = products.categoryid order by categoryname, productname".
8. Click OK to return to the report design surface.

Adding controls to the report to contain data

To add controls to the report

• In the Report Explorer, expand the Fields node, then the Bound node. Drag the following fields onto the detail section and set the following properties of each textbox as indicated.

  DataField	Text	Location
  ProductName	Product Name	1.125, 0
  CategoryName	Category Name	0, 0
  UnitsInStock	Units In Stock	2.25, 0
  UnitsOnOrder	Units On Order	3.375, 0
  UnitPrice	Unit Price	4.5, 0

• Set the BackColor property of the detail section to Thistle.
• Set the CanShrink property of the detail section to True.

Adding code to the Detail_Format event

To write the code in Visual Basic

• Double-click on the detail section of the report. This creates an event-handling method for rptBookmarks' Detail_Format event. Add code to the handler to:
  • Set up Bookmarks

To write the code in C#

• Double-click on the detail section of the report. This creates an event-handling method for rptBookmarks' Detail_Format event. Add code to the handler to:
  • Set up Bookmarks

  The following example shows what the code for the method looks like.

  ' Visual Basic
  Private Sub Detail1_Format(ByVal sender As Object, ByVal e As System.EventArgs) Handles _
  	Detail1.Format
  	Me.Detail1.AddBookmark(txtCategoryName1.text)
  End Sub

  //C#
  private void detail_Format(object sender, System.EventArgs eArgs)
  {
  	detail.AddBookmark(txtCategoryName1.Text);
  }

  The following example shows what the code for the method looks like to set up leveled or nested Bookmarks.

  ' Visual Basic
  Private Sub Detail1_Format(ByVal sender As Object, ByVal e As System.EventArgs) Handles _
  	Detail1.Format
  	Me.Detail1.AddBookmark(txtCategoryName1.Text + "\" + txtProductName1.Text)
  End Sub

  //C#
  private void detail_Format(object sender, System.EventArgs eArgs)
  {
  	detail.AddBookmark(txtCategoryName1.Text + "\\" + txtProductName1.Text);
  }

Previewing the report and Bookmarks Collection in the designer

To preview the report and Bookmarks Collection in the designer

1. Click the "Preview" tab at the bottom of the designer.
2. Click on the "Table of Contents" icon to view the Bookmarks collection.

Viewing the report and Bookmarks Collection at run time

To view the report at run time

1. Add the ActiveReports viewer control to your Windows form.
2. Add the code needed to set the viewer document equal to the report document. See Using the ActiveReports Windows Form Viewer for help.
3. Press F5 to run the report.
4. Click the "Table of Contents" icon to view the Bookmarks collection.

Adding Special Bookmarks at Run Time

To create and add special bookmarks to the bookmarks collection at run time, you will need to add the bookmarks to the report document's pages collection since the bookmarks are generated from the pages collection.

' Visual Basic
Private Sub Detail1_Format(ByVal sender As Object, ByVal e As System.EventArgs) Handles _
	Detail1.Format
    Dim i As Integer
    Try
        For i = 0 To Me.Document.Pages.Count - 1
            Me.Document.Pages(1).AddBookmark("New Bookmark", 8)
        Next
    Catch ex As Exception
    End Try
End Sub

//C#

private void detail_Format(object sender, System.EventArgs eArgs)
{
	for(int i = 0; i<Document.Pages.Count;i++)
	{
		this.Document.Pages[i].AddBookmark("New Bookmark", 25);
	}
}

See Also

 

 

---

Copyright © 2004-2007 Data Dynamics, Ltd. All rights reserved.