GetTxtWordsInArea Method

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

Description

Returns the estimated number of words necessary to fill the geometry of the current linked text.

If you want to display it in a message box, see TxtWordsInAreaDlg. For the estimate on frames, see GetWordsInArea, and to display it as info, see ObjWordsInAreaDlg.

Syntax

lng1 = Fred.GetTxtWordsInArea (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

Note: this works on linked frames. If called on unlinked frames, it will display 0. It will also display 0 if text estimating is not configured properly. For more information see Configure text estimating.

Context

Editing window command

See also

ObjWordsInAreaDlg, GetWordsInArea, TxtWordsInAreaDlg