InsertIndex

Syntax

InsertIndex [.HeadingSeparator = number] [, .Replace = number] [, .Type = number] [, .RightAlignPageNumbers = number] [, .Columns = number]

Remarks

Compiles and inserts an index at the insertion point or replaces an existing index. The index is the result of an INDEX field that you can update when index entries change.

Argument

Explanation

.HeadingSeparator

Specifies the heading separator:

0 (zero) or omitted None

1 Blank Line

2 Letter

.Replace

Specifies whether to replace the index, if it already exists:

0 (zero) or omitted The existing index is not replaced (the instruction has no effect other than to select the index).

1 The existing index is replaced.

.Type

Specifies the type of index:

0 (zero) or omitted Indented

1 Run-in

.RightAlignPageNumbers

If 1, aligns page numbers with the right edge of the column.

.Columns

The number of columns you want in the index.


Example

This example inserts a simple, indented index that replaces the current index, if one exists:


InsertIndex .Type = 0, .HeadingSeparator = 0, .Replace = 1

See Also

AutoMarkIndexEntries, MarkIndexEntry