A script-enabled browser is required for this page to function properly.

SRW.SET_BOOKMARK built-in procedure

This procedure associates a bookmark with the object and specifies a string that will appear in a bookmark frame of the master HTML document or the PDF document. If you open the bookmark area and click the bookmark, the object appears at the top of the window.

Syntax


SRW.SET_BOOKMARK('bookmark');

Parameters

Parameter

Description

bookmark

Is one of the following:

  1. A text string with no indentation/ordering information. The bookmark will appear in the bookmark list according to when the object is rendered by the report.
  2. A text string with explicit ordering/indentation of the form x#book_mark_name, where x is an outline number. The pound sign (#) and outline number do not appear in the bookmark window but are used to determine order and indentatio.

GUI access

You can also define this attribute using the Reports Builder user interface:

Property Inspector

Set the Bookmark property.

Restrictions

Example

Example 1: Defining a Bookmark on a Boilerplate Object

The format trigger below defines a bookmark for the boilerplate object B_2. Notice the use of explicit ordering information (1#) in this example. If you did not want the ordering information, you could omit 1#.


function B_2FormatTrigger return boolean is
begin
   srw.set_bookmark('1#Expense Summary Section');
   return 
 (TRUE);
end;

Example 2: Setting a Bookmark Dynamically

The format trigger below defines a bookmark for the boilerplate object B_2. Notice that the name of the bookmark is dynamic. CATEGORY is a column value that is concatenated with the string Expense Summary Section for each execution of the format trigger. In this case, CATEGORY could contain ordering information (for example, 1#) or perhaps a string that makes the bookmark unique within the report.


function B_2FormatTrigger return boolean is
begin
 SRW.SET_BOOKMARK(:category ||
 ' Expense Summary Section');
 return (TRUE);
end;

See also

About the Reports Builder built-in package (SRW)

SRW built-in package