WwPreviewUtils Function

PV-WAVE Foundation > Reference Guide > Procedure and Function Reference: W > WwPreviewUtils Function

Manages the contents of a preview widget.

Usage

status = WwPreviewUtils(wid[, param1, param2, param3])

Input Parameters

wid — The widget ID of the WwPreview widget.

param1 — (optional) This parameter depends on keyword use in the function calling sequence. See Keywords for more information.

param2 — (optional) This parameter depends on keyword use in the function calling sequence. See Keywords for more information.

param3 — (optional) This parameter depends on keyword use in the function calling sequence. See Keywords for more information.

Returned Value

status — A value indicating success or failure of the function.

1 — Indicates success.

0 — Indicates failure.

Keywords

AutoDefine — If nonzero, automatically defines the header, record, and field regions of the ASCII data file.

Clear — If nonzero, clears all currently selected regions in the preview widget. If the All modifier keyword is also specified, all regions of the ASCII data file are cleared. If All is not specified, specify the following:

param1 — An array of strings containing the types of areas to clear. These types include: ['Header', 'Record', 'Field'].

param2 — The number of areas to clear.

param3 — The areas to clear.

Commit — If nonzero, commits all currently selected regions in the preview widget. If you use this keyword, you must specify the following:

param1 — An array of strings containing the types of areas to commit. These types include: ['Header', 'Record', 'Field'].

param2 — The number of areas to commit.

param3 — The areas to commit.

Format — If specified, selects the datatype format from the following formats; 'FIXED', or 'FREE'. (Default: 'FIXED')

Select — If nonzero, selects the specified regions. If this keyword is used, you must specify the following parameters:

param1 — An array of strings containing the types of areas to select. These types include: ['Header', 'Record', 'Field'].

param2 — The areas to be selected.

SelectionMode — If specified, sets the mode for the selection area to one of the following: 'HEADER', 'RECORD', 'FIELD', 'ANY'.

SeparatorChars — A string containing the characters to use as field separators. For example, to use comma and semicolon as separators, the string would be ’,;’ .

Value — Sets the contents of the preview window to the specified string.