GetAnalyticGrid

Mon 01 January 2018

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 .

Parameters

Field or Control

Definition

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.