WordsInArea Method

Build 1501 on 14/Nov/2017  This topic last edited on: 22/Mar/2016, at 17:08

Description

Returns the estimated number of words fitting in the geometry of the text of the node.

If the node is the root one WordsInArea returns the sum of the estimated number of words in the geometries of all the texts of the article. If the node is an element inside a text WordsInArea returns 0.

Available in Ted and in Fred.

Syntax

dim value as Integer = object.WordsInArea (iMode)

object

Required. Object name. Returned by the GetRootNode, GetCurNode, GetTxtNode, GetParent, GetChild functions of the object, returned by Ted.GetActiveArticle.

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.

Example

The below script returns the estimated number of words fitting in the geometry of the text of the node for the WordCount_1, or 0 if no estimate is defined.

If Ted.HasActiveArticle Then

  dim objA = Ted.GetActiveArticle

  dim objN = objA.GetCurNode

  MsgBox (objN.Wordsinarea(1))

End If

Context

Node object