Using the HomeDashboard Property

The creation of the HomeDashboard property in ActiveDocument means any dashboard section can be specified as the Home section using the object model. Using the HomeDashboard property in Interactive Reporting Studio produces equivalent results to using the Dashboard Home dialog box, or clicking Dashboard Home button on the toolbar when in Design mode, or setting a Home section in Step 7: Configure Properties of Dashboard Studio.

You can modify the example to suit your requirements.

Note:

When specifying a Home section in Dashboard Studio, if the Dashboard Home button is invisible, enter Design mode and select Dashboard, then Home Dialog on the Interactive Reporting Studio menu bar to activate Dashboard Home button and the Dashboard Home dialog box.

*  To use the HomeDashboard property:

  1. In Interactive Reporting Studio, select File, then New.

    New File is displayed.

  2. Select Other, then A Blank Document, and then click OK.

    The document opens in Design mode.

  3. From Sections, right-click Dashboard, and select Duplicate Section.

  4. Right-click Dashboard2, and select Rename Section.

    For example, enter First Dashboard.

  5. Perform an action:

    • Select Dashboard, then Home Dialog

    • Click Dashboard Home button

    Dashboard Home is displayed listing Dashboard and First Dashboard.

  6. Select Dashboard (the original section) and click OK.

  7. Press Ctrl+D to exit Design mode, and click Dashboard Home button.

    The active section becomes Dashboard (if not already selected).

  8. Press Ctrl+D to return to Design mode.

  9. From the catalog pane, expand Controls, and drag a command button onto Dashboard.

  10. Right-click CommandButton1, and select Scripts.

    Script Editor is displayed.

  11. Copy and paste this script, or modify to suit your requirements, and click OK.

    ActiveDocument.HomeDashboard = "First Dashboard";

  12. Press Ctrl+D to exit Design mode, and click CommandButton1, and then click Dashboard Home button.

    The active section becomes First Dashboard, demonstrating that the Home dashboard has changed from Dashboard to First Dashboard.

  13. From Sections, select Dashboard.

  14. Save and close the dashboard.

  15. Reopen the dashboard.

    First Dashboard is displayed as the Home section for the dashboard.