Show / Hide Table of Contents
  • BC HTML Api reference
    • html-api
      • AnnotationArrowOrientation
      • AnnotationTextAlignment
      • AnnotationTextFontFamily
      • BarcodeOrientation
      • BarcodeThresholdMode
      • BarcodeType
      • BatchEnums
        • Mode
        • Queue
      • CallContext
      • DbClient
      • DbServer
      • FileMimeType
      • FileType
      • IAnnotation
      • IAnnotationProperties
      • IApplication
      • IBarcodeData
      • IBaseControl
      • IBatch
      • IBatchClass
      • IButton
      • ICheckBox
      • IComboBox
      • ICustomThemeConfig
      • IDocument
      • IDocumentClass
      • IField
      • IFieldValidation
      • IFileInfo
      • IFolder
      • IFolderClass
      • IFormType
      • IGroup
      • IIndexClass
      • IITModule
      • IJob
      • ILabel
      • ILicenseGroup
      • IListItem
      • IListView
      • ImageColorMode
      • ImageOperationType
      • INode
      • INodeComment
      • INodeReviewComment
      • INuanceEngineConfig
      • IOCRConfiguration
      • IPage
        • Side
      • IRadioButton
      • IRecognitionProfile
      • IRectangle
      • IRegexValidation
      • IScanProfile
      • ITable
      • ITabView
      • ITextBox
      • IthConfig
      • ITitledPanel
      • IUser
      • LevelName
      • NodeReviewStatus
      • NuanceEngine
      • NuanceLanguage
      • NuanceMode
      • PageSideMode
      • RecognitionEngine
      • RpcService
      • ScanService
      • ScanSource
      • ScriptActionType
      • ScriptResultConsts
      • ScriptResultProp
      • UnloadReason

Interface IIndexClass

An IndexClass describes the index data that may be associated with a INode.

The IField objects returned from the methods of this class are read-only. All methods of these IField objects that are value-specific (for example IField.getValue()) will throw an Error.

Properties list

description name

Methods list

getDescription() getField(name) getFields() getFieldsAsList() getName()

Properties

description

see IIndexClass.getDescription()

Declaration
readonly description: string;
Property Value
Type Description
string

name

see IIndexClass.getName()

Declaration
readonly name: string;
Property Value
Type Description
string

Methods

getDescription()

The description of this IndexClass

Declaration
getDescription(): string;
Returns
Type Description
string

getField(name)

Declaration
getField(name: string): IField;
Parameters
Type Name Description
string name

the name of the Index Field

Returns
Type Description
IField

the IField object with that name.

getFields()

A name-IField map

Declaration
getFields(): Map<string, IField>;
Returns
Type Description
Map<string, IField>

getFieldsAsList()

The list of IField

context
returns a java.util.List<IField> instead of IField[]
context
returns a java.util.List<IField> instead of IField[]
Declaration
getFieldsAsList(): IField[];
Returns
Type Description
IField[]

getName()

The name of this IndexClass

Declaration
getName(): string;
Returns
Type Description
string
Back to top Generated by DocFX