RenderIndex Class

Represents an alphabetical, optionally multi-level, word index in a C1PrintDocument.

Object Model

Syntax

Visual Basic
C#

'Declaration
 
Public Class RenderIndex 
   Inherits RenderArea
   Implements IDocumentLocation, IStyleOwner

public class RenderIndex : RenderArea, IDocumentLocation, IStyleOwner

Remarks

To create an index, follow these steps:

Create an instance of the RenderIndex class, store it in a local variable.
For each index entry, create an instance of the IndexEntry class.
For each occurrence of each index entry in the document, create an instance of the IndexEntryOccurrence class, and set the Target on it to point to the location of that occurrence in the document.
After all occurrences have been added to their entries, and all entries have been added to the Entries, add the RenderIndex object created in the first step, to the document. When the document generates, that object will create the alphabetically sorted word index with clickable page numbers.

Inheritance Hierarchy

System.Object
   C1.C1Preview.RenderObject
      C1.C1Preview.RenderArea
         C1.C1Preview.RenderIndex

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

RenderIndex Members
C1.C1Preview Namespace
IndexEntry Class
IndexEntryOccurrence Class
IndexEntryCollection Class
IndexEntryStyles Class
C1LinkTarget Class