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 ITable

Represents an Index Table of an object (INode) in a Batch.

Note: Write-access to properties depends on the context in which the model is used. When in a read-only context, set* methods will throw an Error.

Properties list

columnCount columns name rowCount

Methods list

addRow() deleteRow(index) getColumnCount() getColumns() getName() getRowCount() getValueAt(row, column) insertRow(index) setValueAt(row, column, value)

Properties

columnCount

see ITable.getColumnCount()

Declaration
readonly columnCount: number;
Property Value
Type Description
number

columns

see ITable.getColumns()

Declaration
readonly columns: Array<IField>;
Property Value
Type Description
Array<IField>

name

see ITable.getName()

Declaration
readonly name: string;
Property Value
Type Description
string

rowCount

see ITable.getRowCount()

Declaration
readonly rowCount: number;
Property Value
Type Description
number

Methods

addRow()

Add a new (empty) row to the table.

Note: this method will throw an Error if invoked in read-only context.

Declaration
addRow(): any;
Returns
Type Description
any

deleteRow(index)

Removes the row at the supplied index.

Note: this method will throw an Error if invoked in read-only context.

Declaration
deleteRow(index: number): any;
Parameters
Type Name Description
number index
Returns
Type Description
any

getColumnCount()

Returns the number of columns in this table.

Declaration
getColumnCount(): number;
Returns
Type Description
number

getColumns()

Get the columns of this table. Each column is represented by an IField object which serves as the column's definition (specifying its type, validations, format etc)

Declaration
getColumns(): Array<IField>;
Returns
Type Description
Array<IField>

getName()

Returns the name of this table

Declaration
getName(): string;
Returns
Type Description
string

getRowCount()

Returns the number of rows in this table.

Declaration
getRowCount(): number;
Returns
Type Description
number

getValueAt(row, column)

Get the value at the given row and column in the table

Declaration
getValueAt(row: number, column: number): string;
Parameters
Type Name Description
number row
number column
Returns
Type Description
string

insertRow(index)

Insert a new, empty row in the table at the specified index

Note: this method will throw an Error if invoked in read-only context.

Declaration
insertRow(index: number): any;
Parameters
Type Name Description
number index
Returns
Type Description
any

setValueAt(row, column, value)

Sets the value at the specified row and column for this table in a read-write context. You should make sure that the value you write is in the standard internal format. For example, if you are setting a date like Feb 3, 2015, the value should be '2015-02-03'. Do not call this method with a user-formatted value (e.g. 3/2/2015) because it will create incosistencies that are hard to identify later.

Note: this method will throw an Error if invoked in read-only context.

Declaration
setValueAt(row: number, column: number, value: string): any;
Parameters
Type Name Description
number row
number column
string value
Returns
Type Description
any
Back to top Generated by DocFX