ObjWordsInAreaDlg Method

Build 1501 on 14/Nov/2017  This topic last edited on: 23/Mar/2016, at 12:12

Description

Displays in a message box the estimated number of words necessary to fill the selected frames.

If you need only a value, see GetWordsInArea. For the estimate on text linked to frames see GetTxtWordsInArea (returns the result as string) and TxtWordsInAreaDlg (displays a message box with info).

Syntax

Fred.ObjWordsInAreaDlg (imode)

iMode        

Required. Selector of what is returned

0 = the estimate, based on valued in the WordCount section.

1 = the estimate, based on valued in the WordCount_1 section.

2 = the estimate, based on valued in the WordCount_2 section.

Remarks

This works on linked and unlinked frames. It will display 0 if text estimating is not configured properly. For more information see Configure text estimating.

For the estimate on text linked to frames see GetTxtWordsInArea (returns the result as string) and TxtWordsInAreaDlg (displays a message box with info).

Return value

Returns error code.

Context

Fred application dispatcher commands

See also

GetTxtWordsInArea, GetWordsInArea, TxtWordsInAreaDlg