Description

Displays the estimated number of words necessary to fill the geometry of the current text. If you want to display it in a message box, see GetTxtWordsInArea. For the estimate on selected frames see GetWordsInArea (returns the result as string) and ObjWordsInAreaDlg (displays a message box with info).

Syntax

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.

Return value

Returns error code.

Remarks

This works on linked frames only. If called on unlinked frames, it won't even appear. It will display 0 if text estimating is not configured properly. For more information see Configure text estimating.

Context

Fred application dispatcher commands

See also

ObjWordsInAreaDlg, GetTxtWordsInArea, GetWordsInArea