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 IBarcodeData

Provides information on recognized Bar Codes in the Page

Properties list

barcodeType rectHeight rectWidth rectX rectY value

Methods list

getBarcodeType() getRectHeight() getRectWidth() getRectX() getRectY() getValue()
Remarks

alias IPage.BarcodeData

Properties

barcodeType

see IBarcodeData.getBarcodeType()

Declaration
readonly barcodeType: BarcodeType;
Property Value
Type Description
BarcodeType

rectHeight

The height of the Bar Code in the Page.

see IBarcodeData.getRectHeight()

Declaration
readonly rectHeight: number;
Property Value
Type Description
number

rectWidth

see IBarcodeData.getRectWidth()

Declaration
readonly rectWidth: number;
Property Value
Type Description
number

rectX

see IBarcodeData.getRectX()

Declaration
readonly rectX: number;
Property Value
Type Description
number

rectY

see IBarcodeData.getRectY()

Declaration
readonly rectY: number;
Property Value
Type Description
number

value

see IBarcodeData.getValue()

Declaration
readonly value: string;
Property Value
Type Description
string

Methods

getBarcodeType()

Returns the type of Bar Code

Declaration
getBarcodeType(): BarcodeType;
Returns
Type Description
BarcodeType

BarcodeType

getRectHeight()

Returns the height of the Bar Code in the Page. The returned size is relative to the Page's height and it is a number between 0 and 1.0.

If global parameter use_relative_page_coordinates_and_point_size is set to false, then the returned value is an absolute size.

Declaration
getRectHeight(): number;
Returns
Type Description
number

getRectWidth()

Returns the width of the Bar Code in the Page. The returned size is relative to the Page's width and it is a number between 0 and 1.0.

If global parameter use_relative_page_coordinates_and_point_size is set to false, then the returned value is an absolute size.

Declaration
getRectWidth(): number;
Returns
Type Description
number

getRectX()

Returns the X coordinate of the top-left corner of the Bar Code in the Page. The returned coordinate is relative to the Page's width and it is a number between 0 and 1.0.

If global parameter use_relative_page_coordinates_and_point_size is set to false, then the returned value is an absolute coordinate.

Declaration
getRectX(): number;
Returns
Type Description
number

getRectY()

Returns the Y coordinate of the top-left corner of the Bar Code in the Page. The returned coordinate is relative to the Page's height and it is a number between 0 and 1.0.

If global parameter use_relative_page_coordinates_and_point_size is set to false, then the returned value is an absolute coordinate.

Declaration
getRectY(): number;
Returns
Type Description
number

getValue()

Returns the value of the Bar Code

Declaration
getValue(): string;
Returns
Type Description
string

string

Back to top Generated by DocFX