SetGroupletType method: Field class

Syntax

SetGroupletType(type)

Description

Use the SetGroupletType method to set the type of grouplet.

A grouplet is the encapsulation of content from one source (for example, a component, an iScript, or external content) that is presented within the context of another fluid application page. Tiles, embedded related content, and related information are all examples of grouplets. In each of these scenarios, the grouplets are created by the system at runtime based solely on configuration details. However, you can use this and other methods and properties of the Field class to generate grouplets from group box fields programmatically.

Important:

Use this method within fluid applications only.

Parameters

Parameter Description

type

Specifies the type for the grouplet as an integer constant.

Use the following integer constants (integer values are provided for reference only):

Numeric Value Constant Value Description

0

%GroupletNone

Not a grouplet (also referred to as a tile). This is a regular group box with its content coming from the same page records.

1

%GroupletWithStyle

Grouplet with style. This producer tile includes its own style sheets, JavaScript, or both.

Important: Be aware that this setting can inject style settings or JavaScript code that conflicts with those defined for the page.

2

%GroupletNoStyle

Grouplet without style. This producer tile does not include style sheets or JavaScript.

Note: This is the recommended setting.

3

%GroupletIframe

Interactive grouplet.

4

%GroupletIframeExt

Interactive grouplet for external content.

5

%GroupletIframeAutoSize

Interactive grouplet with autosizing.

Note: Use this setting for homepage and dashboard tiles only.

6

%GroupletIframeExtAutoSize

Interactive grouplet for external content with autosizing.

Note: Use this setting for homepage and dashboard tiles only.

7

%GroupletIframeVAutoSize

Interactive grouplet with vertical autosizing. The system will autosize the grouplet height based on the content at initial load. The grouplet will be automatically resized by the system when:

  • The window is resized.

  • Any field change or server trip is invoked within the grouplet.

  • Any group boxes within the grouplet are expanded or collapsed.

  • When either side panel is opened or closed.

Important:

While a grouplet can be defined as interactive, you should be aware of the limitations. See the section, “Limitations with Interactive Grouplets,” in Portal Technology: Fluid Related Content for more information.

Returns

None.

Example

/* Use the following three methods to create a display-only grouplet.    */
&fld.SetGroupletType(%GroupletNoStyle);
/* Specifies the grouplet's source content */
&fld.SetGroupletUrl(&src_URL);
/* Specifies the group box's page field name. Not used with interactive  */
/* grouplets, which render the entire component.                         */
&fld.SetGroupletID("GRPLTC_NOINTER");

Related Topics