GetGrid
Mon 01 January 2018Syntax
GetGrid(Page.page_name, grid_name, [L1_row_num])
Description
Use the GetGrid function to instantiate an object of the Grid class and populate it with the grid specified by grid_name . For grids at level 2, specify the optional L1_row_num parameter. The grid_name corresponds to the Page Field Name on the General tab of that gridâs page field properties.
Use the GetGrid function to return a reference to a Grid object. If you want to access an AnalyticGrid object, use the GetAnalyticGrid function instead.
Note: If more than one occurs count was specified for the grid in Application Designer, GetGrid will return only the first occurrence of the grid.
Note: PeopleSoft builds a page grid one row at a time. Because the Grid class applies to a complete grid, you canât attach PeopleCode that uses the Grid class to events that occur before the grid is built; the earliest event you can use is the Activate event for a page.
See .
Parameters
|
Field or Control |
Definition |
|---|---|
| Page. page_name |
Specify the name of the page definition containing the grid you want. |
| grid_name |
Specify the Page Field Name on the General tab of the gridâs page field properties. Specify a grid name consisting of any combination of uppercase letters, digits and "#", "$", "@", and "_". |
| L1_row_num |
Specify the row in the parent (level 1) scroll that contains this grid. Therefore, specify this parameter for grids at level 2 only. Note: The default value is 1. |
Returns
A Grid object populated with the requested grid.