Return a DataGrid as a string.

Syntax

MAKESUBFILEINTOSTRING(sDataGridName, All_Pages, Include_Heading, sHeader_Column_ Numbers, sDetail_Column_Numbers)

Parameters

sDataGridName

Required. String that contains the name of the data grid that is to be returned as a string.  

All_Pages

Optional. Boolean that tells the function to page down through all pages in the subfile. Defaults to false.

Include_Heading

Optional. Boolean that tells the function to include the subfile header rows in the returned string. Defaults to true

sHeader_Column_Numbers

Optional. String that contains the column numbers of the header rows to show, delimited by commas. Default is all non-blank columns

sDetail_Column_Numbers

Optional. String that contains the column numbers of the detail rows to show, delimited by commas. Default is the columns used for the header columns

Return Value

sSubfileAsString

Required. String that contains the subfile as a tab delimited string.  

Examples

     /* Get just the currently visible page of the subfile named uDataGrid */
     /* Get the header rows, */
     /* and paste them all onto the clipboard.                            */
     /* Only show the header cells in columns 0,2,3,4 and 5               */
     /* Only show the detail cells in columns 1,2,3,4 and 6               */

     COPYTOCLIPBOARD(MAKESUBFILEINTOSTRING("uDataGrid", false , true ,"0,2,3,4,5" , "1,2,3,4,6"));

     /* Get all the pages of the subfile named uDataGrid                  */
     /* Get the header rows, */
     /* and paste them all onto the clipboard.                            */
     /* Only show the header cells in columns 0,2,3,4 and 5               */
     /* Only show the detail cells in columns 1,2,3,4 and 6               */

     COPYTOCLIPBOARD(MAKESUBFILEINTOSTRING("uDataGrid", true, true , "0,2,3,4,5" , "1,2,3,4,6"));

     /* Get all the pages of the subfile named uDataGrid                  */
     /* Get the header rows, */
     /* and paste them all onto the clipboard.                            */
     /* Only show the header cells in columns 0,2,3,4 and 5               */
     /* Only show the detail cells in columns 0,2,3,4 and 5               */

     COPYTOCLIPBOARD(MAKESUBFILEINTOSTRING("uDataGrid", true, true , "0,2,3,4,5" ));

     /* Get all the pages of the subfile named uDataGrid                  */
     /* Get the header rows, */
     /* and paste them all onto the clipboard.                            */
     /* Show the non-blank header cells                                   */
     /* Only show the detail cells in columns 1,2,3,4 and 6               */

     COPYTOCLIPBOARD(MAKESUBFILEINTOSTRING("uDataGrid", true, true , null ,"1,2,3,4,6"));

     /* Get all the pages of the subfile named uDataGrid                  */
     /* Get the header rows, */
     /* and paste them all onto the clipboard.                            */
     /* Show the non-blank header cells                                   */
     /* Only show the detail cells in columns with non-blank headers      */

     COPYTOCLIPBOARD(MAKESUBFILEINTOSTRING("uDataGrid", true, true));

     /* Get all the pages of the subfile named uDataGrid                  */
     /* Get all the detail rows, but don't get the header rows,           */
     /* paste them onto the clipboard.                                    */
     /* Only show the detail cells in columns 1,2,3,4 and 6               */

     COPYTOCLIPBOARD(MAKESUBFILEINTOSTRING("uDataGrid", true , false , null, "1,2,3,4,6"));

Notes:

  • Use the probe screen report to ensure that Newlook is displaying the subfile as a datagrid, and to determine the column numbers of the header and detail cells that you want to show.
  • Can be used in combination with function COPYTOCLIPBOARD to allow the user to paste a subfile into their own excel spreadsheet.
  • No labels