ComponentOne Reports for WinForms Designer Edition: ComponentOne Reports for WinForms > Working with C1PrintDocument > Word Index

Word Index

You can now automatically generate indexes using C1PrintDocument. Each index (there can be several indexes in a document) consists of an alphabetized sorted list of letter headings with entries followed by lists of page numbers where the entry occurs.

An index is represented by an instance of the RenderIndex class, a render object derived from RenderArea. You can add that object to the document as you would any other render object, but with one important limitation: the index must appear in the document after all occurrences of entries (terms) contained in it; so, like the traditional index, the index here would be best served to appear at the end of the document.

Terms are words and word combinations that occur in the document and should appear as entries in the index. When the document is created, these terms are added to the RenderIndex object together with information about locations where they occur (usually  the RenderText or RenderParagraph containing the term). Then, when the document generates, the RenderIndex object produces the actual index.


Classes Supporting the Index Feature

Generating an Index In Code

Customizing the Index's Appearance

The Structure of the Generated Index


Send comments about this topic to ComponentOne.
Copyright © ComponentOne LLC. All rights reserved.