GetAnalyticGrid function

Syntax

GetAnalyticGrid(Page.page_name, grid_name)

Description

Use the GetAnalyticGrid function to instantiate an analytic grid object from the AnalyticGrid class, and populates it with the grid specified by grid_name, which is the Page Field Name on the General tab of that analytic grid’s page field properties.

Note:

PeopleSoft builds a page grid one row at a time. Because the AnalyticGrid class applies to a complete grid, you can’t attach PeopleCode that uses the AnalyticGrid class to events that occur before the grid is built; the earliest event you can use is the page Activate event.

See PeopleCode Developer’s Guide: Activate Event.

Parameters

Parameter	Description
Page. page_name	Specify the name of the page definition containing the grid you want to access. Specify a grid name consisting of any combination of uppercase letters, digits and "#", "$", "@", and "_".
grid_name	Specify the Page Field Name on the General tab of the grid’s page field properties.

Returns

A reference to an AnalyticGrid object.

Specifying the Grid Name

When you place an analytic grid on a page, the grid is automatically named the same as the name of the primary record of the scroll for the grid (from the Page Field Name field). This is the name you use with the GetAnalyticGrid function.

Note:

If the name of the record changes, the Page Field Name is not automatically updated. You must change this name if you want the name of the grid to reflect the name of the record.

To change a grid name:

1. Open the page definition in PeopleSoft Application Designer.

2. Select the analytic grid and access the Analytic Grid control properties.

3. On the General tab, type the new grid name in the Page Field Name field.

Note:

Every grid on a page must have a unique name.