TPResponse Class Methods

The following are the TPResponse methods:

Syntax

isThisPageletMinimized(param1) 

Description

Use this method to return a Boolean value indicating whether the current instance of the template pagelet is minimized.

This method should be used by hidden template pagelets only. When a hidden template pagelet is minimized, no data is shown within the pagelet. However, the hidden pagelet is still called. To avoid unnecessary processing, template pagelets that can be hidden should always check this property before processing, and return immediately if false.

Note: This method should not be used for template pagelets without the CANBEINVISIBLE attribute set.

Parameters

None

Returns

A Boolean value: True if the current pagelet is minimized, False otherwise.

Syntax

WritePageletHTML(HTML, CREF_label, CREF_name) 

Description

Use this method to write special pagelet output so that the pagelet container will only be generated when appropriate.

Use this method with template pagelets that can be hidden. If the pagelet is currently not displayed (that is, minimized), call this method with the HTML parameter set to an empty string.

Oracle recommends calling this method with both CREF_label and CREF_name set to an empty string.

Note: This method should not be used for template pagelets without the CANBEINVISIBLE attribute set.

Parameters

Parameter

Description

HTML

Specifies the HTML to be written to the template pagelet as a string.

CREF_label

Specifies the label for the template pagelet as a string. Specifying an empty string will cause the Context Manager to look up the appropriate value in the portal registry.

CREF_name

Specifies the name for the template pagelet as a string. Specifying an empty string will cause the Context Manager to look up the appropriate value in the portal registry.

Returns

None

Example

&TPResponse.WritePageletHTML(&HTML, "", "");