Class actuate.viewer.PageContent

Description

A container for the content of a report document file. actuate.Viewer.PageContent contains a comprehensive list of report elements, such as tables, charts, labels, and data items.

Constructor

The PageContent object is constructed by actuate.viewer.getCurrentPageContent( ).

Function summary

Table 4-43 lists actuate.viewer.PageContent functions.

Table 4-43  actuate.viewer.PageContent functions 

Function	Description
getChartByBookmark( )	Returns a chart element specified by the given bookmark.
getDataItemByBookmark( )	Returns a data element specified by the given bookmark.
getFlashObjectByBookmark( )	Returns a Flash object specified by the given bookmark.
getGadgetByBookmark( )	Returns a Flash gadget specified by the given bookmark.
getLabelByBookmark( )	Returns a label element specified by the given bookmark.
getTableByBookmark( )	Returns a table element specified by the given bookmark.
getTextByBookmark( )	Returns a text element specified by the given bookmark.
getViewerId( )	Returns the viewer ID.

actuate.viewer.PageContent.getChartByBookmark

Syntax

actuate.viewer.Chart PageContent.getChartByBookmark(string bookmark)

Returns the chart element specified by the given bookmark.

Parameters

bookmark

String. A bookmark to identify a chart element. When the bookmark value is not given, this function returns the first chart element found in the report content.

Returns

actuate.viewer.Chart object.

Example

This example retrieves the chart object and changes the chart title.

this.onclick = function(event)

{

  var bviewer = this.getViewer( );

  var bpagecontents = bviewer.getCurrentPageContent( );

  var bchart = bpagecontents.getChartByBookmark("ChartBookmark");

  bchart.setChartTitle("Orders By Country (Classic Cars)");

  bchart.submit( );

}

actuate.viewer.PageContent.getDataItemByBookmark

Syntax

actuate.viewer.PageContent PageContent.getDataItemByBookmark(string bookmark)

Returns the data element specified by the given bookmark.

Parameters

bookmark

String. A bookmark to identify a data element. When the bookmark value is not given, the first data element found in the report content is returned.

Returns

actuate.viewer.PageContentobject.

Example

Use this function to access the bookmarks for specific elements in the page content. For example, to access the data element "myDataItem" on the page loaded in the myViewer Viewer object, use the following code:

var element = myViewer.getCurrentPageContent( ).getDataItemByBookmark("myDataItem");

actuate.viewer.PageContent.getFlashObjectByBookmark

Syntax

actuate.report.FlashObject PageContent.getFlashObjectByBookmark(string bookmark)

Returns the Flash object specified by the given bookmark.

Parameters

bookmark

String. A bookmark to identify a Flash object. When the bookmark value is not given, the first data element found in the report content is returned.

Returns

actuate.report.FlashObject object.

Example

Use this function to access the bookmarks for specific elements in the page content. For example, to access the Flash object "myFlashObj" on the page loaded in the myViewer Viewer object, use the following code:

var element = myViewer.getCurrentPageContent( ).getFlashObjectByBookmark("myFlashObj");

actuate.viewer.PageContent.getGadgetByBookmark

Syntax

actuate.report.Gadget PageContent.getGadgetByBookmark(string bookmark)

Returns the gadget element specified by the given bookmark.

Parameters

bookmark

String. A bookmark to identify a gadget element. When the bookmark value is not given, the first data element found in the report content is returned.

Returns

actuate.report.Gadget object.

Example

Use this function to access the bookmarks for specific elements in the page content. For example, to access the gadget "myGadget" on the page loaded in the myViewer Viewer object, use the following code:

var element = myViewer.getCurrentPageContent( ).getGadgetByBookmark("myGadget");

actuate.viewer.PageContent.getLabelByBookmark

Syntax

actuate.report.Label PageContent.getLabelByBookmark(string bookmark)

Returns the label element specified by the given bookmark.

Parameters

bookmark

String. A bookmark to identify a label element. When the bookmark value is not given, the first label element found in the report content is returned.

Returns

actuate.report.Label object.

Example

Use this function to access the bookmarks for specific elements in the page content. For example, to access the label "LabelOne" on the page loaded in the myViewer Viewer object, use the following code:

var element = myViewer.getCurrentPageContent( ).getLabelByBookmark("LabelOne");

actuate.viewer.PageContent.getTableByBookmark

Syntax

actuate.report.Table PageContent.getTableByBookmark(string bookmark)

Returns the table element specified by the given bookmark.

Parameters

bookmark

String. A bookmark to identify a table element. When the bookmark value is not given, the first table element found in the report content is returned.

Returns

actuate.report.Table object.

Example

Use this function to access the bookmarks for specific elements in the page content. For example, to access the table mytable on the page loaded in the myViewer Viewer object, use the following code:

var element = myViewer.getCurrentPageContent( ).getTableByBookmark("mytable");

actuate.viewer.PageContent.getTextByBookmark

Syntax

actuate.report.TextItem PageContent.getTextByBookmark(string bookmark)

Returns the text element specified by the given bookmark.

Parameters

bookmark

String. A bookmark to identify a text element. If the bookmark value is not given, the first text element found in the report content is returned.

Returns

actuate.report.TextItem object.

Example

Use this function to access the bookmarks for specific elements in the page content. For example, to access the text item "myTextItem" on the page loaded in the myViewer Viewer object, use the following code:

var element = myViewer.getCurrentPageContent( ).getTextByBookmark("myTextItem");

actuate.viewer.PageContent.getViewerId

Syntax

string PageContent.getViewerId( )

Returns the viewer ID.

Returns

String. The viewer ID.

Example

This example displays the viewer ID in an alert box.

alert("The Viewer ID is " + myViewer.getViewerId( ));

(c) Copyright Actuate Corporation 2011