GetNumResSummaryData

Returns the string value of the specified cell in the Numerical Results Summary Window of the first graphical view of the document.

Syntax

GetNumResSummaryData(doc, row, col)

Parameters

Parameter

Type

Description

doc

documentReference

Reference to the document

row

number

1-based row number.

col

number

1-based column number.

Return

Returns the string value of the specified cell in the Numerical Results Summary Window of the first graphical view of the document.

Note

In Python, use GetAllNumResSummaryData() NexDoc method to get all the summary values at once.

Examples

Python

import nex
doc = nex.GetActiveDocument()
nex.ApplyTemplate(doc, "PerieventHistograms")

# get the value of the cell in row 3, column 2
summaryCellString = nex.GetNumResSummaryData(doc, 3, 2)
# get all the values in summary
summary = doc.GetAllNumResSummaryData()
# summary now contains a list object with all the values of summary of numerical results window
# for example, to get the 5-th value of the first column of summary of numerical results, use summary[0][4]

NexScript

doc = GetActiveDocument()
ApplyTemplate(doc, "PerieventHistograms")
% get the value of the cell in row 3, column 2
summaryCellString = GetNumResSummaryData(doc, 3, 2)