Description:
Returns information regarding the properties of viewer columns.
Syntax:
Variant GetColInfo(String sWhat, Variant vColId)
Parameters:
| sWhat | (String) Obtained information type.
id - Column identifier.
index - Column index.
title - Displayed column name.
width - Column width.
count - The number of columns. The vColId parameter must be: null for JavaScript or Empty for VBScript. |
|---|
| vColId | (Variant) Identifier or index of a single column containing the value to be returned.
The $all value means that the value for all columns will be returned in the form of the PmArray object. |
|---|
Return value:
Returns a value or an array of values.
If an error occures, then the method returns:
null for
JavaScript or
Empty for
VBScript (it can be tested by the
Pm.IsValid method).
Example:
JavaScriptVBScriptSelect and copy to clipboard
var oViewer = pMe.Items("/Viewer");
var sTitle = oViewer.GetColInfo("title", 1);
Dim oViewer
Set oViewer = pMe.Items("/Viewer")
Dim sTitle
sTitle = oViewer.GetColInfo("title", 1)
History:
Pm9.00.14: New option
"$all", for obtaining the information about all columns.