ParagraphIndex()

Syntax:

textObject.ParagraphIndex( ParaIndex )

Return:

An integer indicating the Index position before the first character in the paragraph specifed in the parameter ParaIndex. If the number entered in ParaIndex is not a valid paragraph, the Return Value is -1.

Parameter:

ParaIndex – the number of the paragraph you want to check. ParaIndex must be an integer. The paragraphs are numbered using a zero-based index. This parameter is required and the default is 0 (i.e. the first paragraph).

Remarks:

This function returns the Index position before the first character of the specified paragraph in a Text object. This function is often used with the ParagraphLength function and is useful if you want to replace, insert or select text in a particular paragraph.

Examples