<printOptionsDef> Element

The printOptionsDef element is a member of the following categories:

Use the printOptionsDef element to define a Print Options dialog, which allows users to set options for printing a thin presentation bean. This element does not actually prepare the printable page; it sends the requested print information to the specifed printerFriendlyViewDef element.

Note: To invoke the Print Options dialog, insert a dialogLinkDef element in the UIX page that contains the presentation that you want to print. You can render the dialogLinkDef element as a Print button or link.

Attributes

id -- (Required) A unique identifier for this element.

scope -- Determines the accessibility and lifetime of the object; select one of the following values: Request or Session (Default). You must use the default value if you want to be able to refer to this element from a different page in your application.

printerFriendlyViewId -- (Required) Specifies the identifier of the printerFriendlyViewDef element that is to display the printable presentation as requested by the user. This identifier must be contained in the page that the Apply button or link in the PrintOptions dialog navigates to.

applyPage -- Specifies the page that contains the printerFriendlyViewDef element that is specified in the printerFriendlyViewId attribute.

Usage notes

The printOptionsDef element is a child of the biThinSession element.

To render the Print Options dialog that is defined by this element, use the printOptions element.

Use the submitEventDef element to define Apply and Cancel buttons or links in the page that contains the Print Options dialog. The following list identifies the associated events:

In a BLAF application, you can use a BIPageButtonBar to define both buttons.

Example

The following XML fragment provides an example of the definition of the biThinSession element for a Print Options dialog page.


<!-- Sample XML for a Print Options dialog page -->
<bibeans:biThinSession id="bisession1"
biConfiguration="/Project1BIConfig1.xml" >
<!-- Defining the printOptionsDef element -->
<bibeans:printOptionsDef id="printOpts"
applyPage="PrinterFriendly1.uix"
printerFriendlyViewId="prnFriendly1" />
<!-- Defining the Print button -->
<bibeans:submitEventDef id="applyPrintOptionsBtn"
sourceId="printOpts"
sourceEventName="bi_initPFV" />
<!-- Defining the Cancel button -->
<bibeans:submitEventDef id="cancelBtn"
sourceId="printOpts"
sourceEventName="bi_cancel" />
</bibeans:biThinSession>