Your use of this site is conditioned on Your continued compliance with the Terms of Use.

I have read Terms of Use. I am aware I may use the Site and/or its Content for personal use only in accordance with the Terms of Use, as a part of my relationship with ABBYY. It’s expressly forbidden to use the Site and/or its Content for competitive and benchmarking purposes.

IF YOU DO NOT AGREE, DO NOT USE THE SITE.

Terms of Use

The sites https://www.abbyy.com/, https://help.abbyy.com/ and other ABBYY-owned sites (collectively, “Site”) are the property of ABBYY Development Inc. and affiliates, the ABBYY group companies ("ABBYY") and its licensors. BY USING THE SITE, YOU AGREE TO THESE TERMS OF USE; IF YOU DON’T AGREE, DO NOT USE THE SITE.

The services and information that ABBYY provides to You are subject to the following Terms of Use (referred to as “Terms”). ABBYY reserves the right, at its sole discretion, to change, modify, add or remove portions of these Terms, at any time. It is Your responsibility to check these Terms for amendments. ABBYY reserves the right to do any of the following, at any time, without notice: to modify, suspend or terminate operation of or access to the Site, or any portion of the Site, for any reason; to modify or change the Site, or any portion of the Site; and to interrupt the operation of the Site or any portion of the Site for maintenance or other reason. You may not use the Site or any Content for any purpose that is unlawful or prohibited by these Terms, or to solicit the performance of any illegal activity or other activity which infringes the rights of ABBYY or others. You agree that ABBYY may, in its sole discretion and without prior notice, terminate Your access to the Site and/or block Your future access to the Site if ABBYY finds that You have violated these Terms or other agreements. You agree that any violation by You of these Terms will constitute an unlawful and unfair business practice. You agree that ABBYY may, in its sole discretion and without prior notice, terminate Your access to the Site. You agree that ABBYY will not be liable to You or to any third party for termination of Your access to the Site as a result of any violation of these Terms.

Your continued use of the Site means that You agree to the amendments. As long as You comply with these Terms, ABBYY grants You a personal, non-exclusive, non-transferable, limited right to enter and use the Site.

Disclaimer of Warranty

All materials contained herein, the Site and any Content, service or features are provided "AS IS" and "AS-AVAILABLE" without warranty of any kind. ABBYY disclaims all warranties of any kind, including all warranties and conditions of accuracy, merchantability, whether express implied or statutory, fitness for a particular purpose, defects-free, virus-free, contamination title and non-infringement, specific results warranty. Any use of the materials of this site is at Your own discretion and risk and You are solely responsible for any damage to Your computer system, including but not limited to loss of data.

ABBYY DISCLAIMS ALL LIABILITY FOR THE ACTS, OMISSIONS AND CONDUCT OF ANY THIRD PARTIES IN CONNECTION WITH OR RELATED TO YOUR USE OF THE SITE AND/OR ANY SERVICES. YOU ASSUME TOTAL RESPONSIBILITY FOR YOUR USE OF THE SITE AND ANY LINKED SITES AND PAGES. YOUR SOLE REMEDY AGAINST ABBYY FOR DISSATISFACTION WITH THE SITE OR ANY CONTENT IS TO STOP USING THE SITE OR ANY SUCH CONTENT.

Limitation of Liability

Under no circumstances shall ABBYY be liable for any kind of damages, indirect or consequential, exemplary, incidental or punitive damages, including, without limitation loss of profits or revenues and/or costs of replacement goods and all damages resulting from (i) downloading of any software available, (ii) use of the Content or the Site, or the service, or the software, (iii) ABBYY's failure to provide services, whether in action of contract, negligence or other tortuous action even if ABBYY has been informed in advance of the possibility of such damages.If, notwithstanding the other provisions of these Terms, ABBYY is found to be liable to You for any damage or loss which arises out of or is in any way connected with Your use of the Site or any Content, ABBYY’s liability shall in no event exceed fifty US dollars. Some jurisdictions do not allow limitations of liability, so the foregoing limitation may not apply to You.

Transmission and Submission of Information

ABBYY does not guarantee the security of any information transmitted to or from the Site. Any material, information or other communication You transmit or post to this Site will be considered non-confidential. ABBYY will have no obligations with respect to such communications. Additionally, by using the Site, You acknowledge and agree that Internet transmissions are never completely secure. You understand that any message or information You send to the Site may be read or intercepted by others.

By transmitting or posting any information You grant ABBYY an unrestricted royalty free right to copy, disclose, distribute, otherwise dispose and use of such information.

While browsing through this site You agree to refrain from posting or transmitting to or from this Site any unlawful material that may violate any domestic and/or international legislation.

ABBYY may at it's own discretion monitor or review any areas on this site where users transmit or post materials or communicate solely with each other, including but not limited to any kind of chat rooms or user forums. ABBYY will have no liability related to the content of any such areas.

Relevant ABBYY Privacy Policy (Notice) and Cookie Policy (if applicable) apply to use of this Site, and its terms are made a part of these Terms by this reference. In conflict, Privacy Policy (Notice) and Cookie Policy provisions prevail. If You choose to provide ABBYY with your personal information (including but not limited to via web-forms located at the Site), your personal information will be treated in accordance with relevant Privacy Policy (Notice) which is available via link displayed on the same webpage where such information is collected.

Downloads

Any software that is made available to download from this Site is the copyrighted work of ABBYY and/or its suppliers. Such software shall be used in accordance with the respective terms of the end user license agreement (EULA) or terms of service which accompany the software. Any use of the Software not in accordance with the respective agreement is expressly prohibited. ABBYY’s obligations, if any, with regard to its products and services are governed by the agreements pursuant to which they are provided, and nothing on this Site should be construed to alter such agreements.

Should ABBYY make available certain materials for downloading from the Site and expressly agree upon it, You may use information on ABBYY products and services, provided that You (a use such information only for Your personal, non-commercial informational purpose, (b) make no modifications to any such information (c) do not remove any proprietary notices in all copies of such documentation, and (d) not make any additional representations or warranties relating to such documentation. It is expressly forbidden to use the Site or its Content for benchmarking and competitive purposes.

If there is a conflict between these Terms and the terms posted for or applicable to a specific portion of the Site or for any service offered on or through the Site, the latter terms shall control with respect to Your use of that portion of the Site or the specific service.

ABBYY may make changes to any products or services offered on the Site, or to the applicable prices for any such products or services, at any time, without notice. The materials on the Site with respect to products and services may be outdated, and ABBYY makes no commitment to update the materials on the Site with respect to such products and services. ABBYY provides access to ABBYY international data and documentation and may contain references to products and services that are not offered in every country. Such reference does not imply that ABBYY intends to offer such products or services in Your country. Although the Site is accessible worldwide, not all features, products or services referenced or offered through or on the Site are available to all persons or in all geographic locations. ABBYY reserves the right to limit, in its sole discretion, the provision and quantity of any Content, feature, product or service to any person or geographic area. Any offer for any feature, product or service made on the Site is void where prohibited.

Use of Content

All the text, communications, software, scripting, photos, text, video, visual interfaces, graphics, trademarks, logos, music, sounds, images, artwork and computer code and other materials (collectively "Content") are owned, controlled or licensed by or to ABBYY and are protected by intellectual property, competition laws and are provided by ABBYY as a service to its customers only and is exclusively for personal use. Except as expressly provided in these Terms, You may not use any portion of this Site or the Content without ABBYY’s express prior written consent. Usage for benchmarking or competitive purpose is expressly prohibited.

Trademarks

The trademarks, logos, and service marks (collectively "Trademarks") appearing on the ABBYY website are the property of ABBYY, its licensorsand other third-parties. All Trademarks are provided for Your information and do not grant You a license to use them. Neither title nor intellectual property rights are transferred to You.A list of third-party Trademarks and patents is available here.

Links to Third-Party Sites

This site may provide links to other third-party sites. ABBYY makes no representations whatsoever about any other site which You may access through this site. You acknowledge and agree that ABBYY is not responsible for the content of any linked site or any link contained in a linked site.

References on this site to any names, marks, products or services of any third parties or hypertext links to third party sites or information are provided solely as a convenience to You. ABBYY does not endorse or recommend content of such sites.

Mentioning non ABBYY products or services is for informational purposes only and constitutes neither an endorsement, nor a recommendation.

Foreign Legislation

These Terms constitute the entire agreement between You and ABBYY with regard to Your use of the Site, and any and all other written or oral agreements or understandings previously existing between You and ABBYY with respect to such use are hereby superseded. ABBYY’s failure to enforce strict performance of these Terms shall not be construed as a waiver by ABBYY of any provision or any right it has to enforce these Terms, nor shall any course of conduct between ABBYY and You or any other party be deemed to modify any provision of these Terms. These Terms shall not be interpreted or construed to confer any rights or remedies on any third parties.

ABBYY does not warrant compliance with any foreign legislation. If You access the Site, You are solely responsible for compliance with all applicable local laws.

You may not use or export or re-export any Content or any copy or adaptation of such Content, or any product or service offered on the Site, in violation of any applicable laws or regulations, including without limitation international export control laws and regulations, and/or for competition and benchmarking.

Subscription Terms

The Subscription terms incorporate terms on subscription, billing and payment procedure for the use of ABBYY Software on a subscription-based model. You can review the full terms here.

Partner Subscription Terms

The Partner Subscription Terms incorporate terms on subscription, billing and payment procedure for the use of ABBYY Software on a Subscription-based model by partners. You can review the full terms here.

Copyright © 2021 ABBYY Development Inc.

May 2021

ABBYY
  • ABBYY Corporate website
  • Store
  • Products
  • Solutions
  • Resource center
  • Support
  • Partners
  • About ABBYY
  • ABBYY Corporate website
  • Store
Home page
  • FineReader Engine 12 for Linux System Administrator's Guide
  • FineReader Engine 12 for Linux End-User License Agreement
FineReader Engine 12 for Linux Developer's Guide API Reference Text-Related Objects Hyperlink
  • Introduction
    • Basic Usage Scenarios Overview
    • Key New Features
      • Image Input
      • Image Preprocessing
      • Document Analysis
      • OCR and Other Recognition Technologies
      • PDF Conversion
      • Advanced Development Tools
      • Receiving and Exporting Recognized Text
    • Benefits
    • Short Specifications
    • Getting Started
    • Glossary
  • 引导浏览
    • 基本使用场景实现
      • 文档转换
      • 文档存档
      • 书籍存档
      • 文本提取
      • 字段别识别
      • 条形码识别
      • 名片识别
      • 机读区域捕捉
      • 文档分类
      • 图像预处理
      • 文档比对
    • 先进技术
      • 编程方面
        • 错误处理
        • PDF/XPS导出期间的错误处理
        • 属性处理
        • 借助集合进行处理
        • 可连接对象的处理
        • 在 Java 中使用 ABBYY FineReader Engine
        • 进程外服务器实施
      • 配置文件的处理
      • 微调页面预处理、分析、识别和合成参数
      • 导出参数调整
      • 使用 ABBYY FineReader Engine 进行平行处理
      • 导出大文档
      • 处理图像
      • 处理语言
      • 处理布局和块
      • 处理文本
      • 处理字体
      • 循环访问文档页面
      • 使用投票 API
      • 使用文本类型自动检测
      • 识别复选标记
      • 识别条形码
      • 手写体识别
      • 识别手写阿拉伯数字
      • 识别中文、日文和韩文
      • 借助字典进行处理
      • 使用 ABBYY FineReader Engine 正则表达式
      • 识别带空格的词汇
      • 符合 ZUGFeRD 的电子发票
    • 最佳实践
      • 改善识别质量
      • 提高处理速度
      • 源图像建议
        • 拍照提示
        • 文档扫描提示
    • ABBYY FineReader Engine 示例说明
  • API Reference
    • Object Diagram
    • Alphabetical List of Objects and Interfaces
    • Functions
      • InitializeEngine Function
      • DeinitializeEngine Function
    • Engine Object (IEngine Interface)
      • Properties
      • Creation Methods
        • Create<Object> Methods
        • CreateEmptyUserPattern Method
        • CreateExportFileWriter Method
        • CreateFRDocumentFromImage Method
        • CreateMultipageImageWriter Method
        • CreatePoint Method
        • CreateRectangle Method
        • CreateLayoutFromStream Method
      • Processing Methods
        • GetNumberOfPagesInImageFile Method
        • InjectTextLayer Method
        • IsPdfPortfolio Method
        • IsPdfPortfolioFromStream Method
        • IsPdfWithTextualContent Method
        • IsPdfWithTextualContentFromStream Method
        • LoadImageDoc Method
        • LoadImageDocFromFile Method
        • OpenBitmap Method
        • OpenBitmapBits Method
        • OpenDib Method
        • OpenImageFileFromMemory Method
        • PrepareBitmap Method
        • PrepareBitmapBits Method
        • PrepareDib Method
        • RecognizeImageFile Method
      • Supplementary Methods
        • CleanRecognizerSession Method
        • ConvertLanguageIdToLCID Method
        • ConvertLCIDToLanguageId Method
        • GetAvailableLicenses Method
        • LoadModule Method
        • LoadPredefinedProfile Method
        • LoadProfile Method
        • MergePatterns Method
        • ReleaseOnlineLicense Method
        • RestartLicensing Method
        • SetCurrentLicense Method
        • SetLicensingConnectionRecoveryCallback Method
        • SetParallelProcessingCallback Method
        • StartLogging Method
        • StopLogging Method
        • TrainUserPattern Method
    • Image-Related Objects
      • ImageDocument
        • ApplySigmaFilter Method
        • ChangeResolution Method
        • CorrectSkew Method
        • CropImage Method
        • DitherImage Method
        • EnhanceLocalContrast Method
        • EqualizeBrightness Method
        • FindBlackSquares Method
        • GetTextBackgroundColor Method
        • Modify Method
        • RemoveColorObjects Method
        • RemoveColorObjectsEx Method
        • RemoveGarbage Method
        • RemoveMotionBlur Method
        • RemoveNoise Method
        • SaveImageRegionTo Method
        • SaveModified Method
        • SaveTo Method
        • SaveToFile Method
        • SmoothImage Method
        • SmoothTexture Method
        • Transform Method
      • IImageDocumentEvents
        • TransformationMade Method
      • Image
        • EstimateBitmapSize Method
        • GetBitmap Method
        • WriteToFile Method
      • ImageProcessingParams
        • CopyFrom Method
        • LoadFromFile Method
        • SaveToFile Method
      • PrepareImageMode
        • CopyFrom Method
        • LoadFromFile Method
        • SaveToFile Method
      • OfficeConversionSettings
      • OfficeConverters
        • Element Property
        • Add Method
        • DeleteAll Method
        • DeleteAt Method
        • Find Method
        • InsertAt Method
        • Item Method
      • JpegExtendedParams
        • CopyFrom Method
        • LoadFromFile Method
        • SaveToFile Method
      • TiffExtendedParams
        • CopyFrom Method
        • LoadFromFile Method
        • SaveToFile Method
      • PngExtendedParams
        • CopyFrom Method
        • LoadFromFile Method
        • SaveToFile Method
      • ImageModification
        • AddClipRegion Method
        • AddInvertRegion Method
        • AddPaintRegion Method
        • AddRemoveGarbageRegion Method
        • AddReplaceBlackPixelsRegion Method
        • AddReplaceWhitePixelsRegion Method
        • ClearClipRegions Method
        • ClearInvertRegions Method
        • ClearPaintRegions Method
        • ClearRemoveGarbageRegions Method
        • ClearReplaceBlackPixelsRegions Method
        • ClearReplaceWhitePixelsRegions Method
        • CopyFrom Method
        • LoadFromFile Method
        • SaveToFile Method
      • CoordinatesConverter
        • ConvertCoordinates Method
        • LoadFromFile Method
        • SaveToFile Method
      • MultipageImageWriter
        • AddPage Method
      • IImagePasswordCallback
        • GetPassword Method
      • TrainingImagesCollection
        • Element Property
        • Add Method
        • DeleteAll Method
        • DeleteAt Method
        • InsertAt Method
        • Item Method
      • TrainingImage
        • SetBitmapBits Method
        • SetImageData Method
    • Layout-Related Objects
      • Layout
        • UserProperty Property
        • Clean Method
        • CopyFrom Method
        • LoadFromFile Method
        • SaveToArray Method
        • SaveToFile Method
        • SaveToStream Method
        • SortedBlocks Property
      • LayoutBlocks
        • Element Property
        • AddNew Method
        • DeleteAll Method
        • DeleteAt Method
        • IndexOf Method
        • Item Method
      • Block
        • UserProperty Property
        • GetAsBarcodeBlock Method
        • GetAsCheckmarkBlock Method
        • GetAsCheckmarkGroup Method
        • GetAsRasterPictureBlock Method
        • GetAsSeparatorBlock Method
        • GetAsSeparatorGroup Method
        • GetAsTableBlock Method
        • GetAsTextBlock Method
        • GetAsVectorPictureBlock Method
        • Move Method
      • TextBlock
        • CopyFrom Method
      • TextBlockAnalysisParams
      • TableBlock
        • FindBaseCellFromPoint Method
        • InitializeGrid Method
      • TableCells
        • Element Property
        • IndexOf Method
        • Item Method
        • Merge Method
        • Split Method
      • TableCell
        • ChangeBlockType Method
      • TableSeparators
        • Element Property
        • AddNew Method
        • DeleteAll Method
        • DeleteAt Method
        • IndexOf Method
        • Item Method
      • TableSeparator
        • Type Property
        • SetType Method
      • BarcodeBlock
        • CopyFrom Method
      • RasterPictureBlock
        • CopyFrom Method
        • SetBlockLayerType Method
      • VectorPictureBlock
        • SetBlockLayerType Method
      • CheckmarkGroup
        • Element Property
        • AddNew Method
        • DeleteAll Method
        • DeleteAt Method
        • Item Method
      • CheckmarkBlock
        • CopyFrom Method
      • CheckmarkTrainingData
        • CopyFrom Method
        • LoadFromFile Method
        • SaveToFile Method
      • SeparatorGroup
        • Element Property
        • AddNew Method
        • DeleteAll Method
        • DeleteAt Method
        • Item Method
      • SeparatorBlock
        • CopyFrom Method
    • Language-Related Objects
      • LanguageDatabase
        • CreateCompoundTextLanguage Method
        • CreateNewDictionary Method
        • CreateTextLanguage Method
        • LoadFrom Method
        • OpenDictionaryExtension Method
        • OpenExistingDictionary Method
      • TextLanguage
        • LetterSet Property
        • UserProperty Property
        • CopyFrom Method
        • LoadFromFile Method
        • SaveToFile Method
      • BaseLanguages
        • Element Property
        • AddNew Method
        • DeleteAll Method
        • DeleteAt Method
        • Item Method
      • BaseLanguage
        • LetterSet Property
        • UserProperty Property
        • CopyFrom Method
        • LoadFromFile Method
        • SaveToFile Method
      • PredefinedLanguages
        • Element Property
        • Find Method
        • Item Method
      • PredefinedLanguage
      • DetectedLanguages
        • Element Property
        • Item Method
      • DetectedLanguage
      • Dictionary
        • AddWord Method
        • AddWords Method
        • DeleteAllWords Method
        • DeleteWord Method
        • DeleteWords Method
        • EnumWords Method
      • EnumDictionaryWords
        • Next Method
        • Reset Method
      • DictionaryDescriptions
        • Element Property
        • AddNew Method
        • DeleteAll Method
        • DeleteAt Method
        • Item Method
      • DictionaryDescription
        • GetAsExternalDictionaryDescription Method
        • GetAsRegExpDictionaryDescription Method
        • GetAsStandardDictionaryDescription Method
        • GetAsUserDictionaryDescription Method
      • StandardDictionaryDescription
      • UserDictionaryDescription
      • RegExpDictionaryDescription
        • SetText Method
      • ExternalDictionaryDescription
        • SetDictionary Method
      • ExternalDictionaryCallback
        • ExternalDictionaryResult Method
      • IExternalDictionary Interface
        • CheckPrefix Method
        • CheckWords Method
      • FuzzyStrings
        • Element Property
        • Item Method
      • FuzzyString
        • CharacterVariants Property
    • Text-Related Objects
      • Text
        • AppendEmptyParagraph Method
        • GetRange Method
        • Remove Method
        • RemoveAll Method
      • Paragraphs
        • Element Property
        • IndexOf Method
        • Item Method
      • Paragraph
        • Bookmark Property
        • ColumnNumber Property
        • Hyperlink Property
        • DeleteBookmark Method
        • GetBookmarkRange Method
        • GetCharParams Method
        • GetDropCapCharParams Method
        • GetHyperlinkRange Method
        • GetWordRecognitionVariants Metho
        • Insert Method
        • InsertParagraphBreak Method
        • InsertTab Method
        • InsertText Method
        • NextGroup Method
        • Range Method
        • Remove Method
        • SetBookmark Method
        • SetCharParams Method
        • SetHyperlink Method
        • UserBookmark Property
      • ParagraphLines
        • Element Property
        • Item Method
      • ParagraphLine
      • ParagraphParams
        • CopyFrom Method
        • LoadFromFile Method
        • SaveToFile Method
      • CharParams
        • CopyFrom Method
        • SetFont Method
        • SetRect Method
      • ParagraphStyle
      • FontStyle
        • SetFont Method
      • WordRecognitionVariants
        • Element Property
        • Item Method
      • WordRecognitionVariant
        • GetCharParams Method
      • CharacterRecognitionVariants
        • Element Property
        • Item Method
      • CharacterRecognitionVariant
      • Words
        • Element Property
        • Item Method
      • Word
        • GetRecognitionVariants Method
      • Hyperlink
        • ParseTarget Method
      • TabPositions
        • Element Property
        • AddNew Method
        • DeleteAll Method
        • DeleteAt Method
        • Item Method
      • TabPosition
      • TextOrientation
        • CopyFrom Method
        • IsEqualTo Method
      • ListParams
        • AddToList Method
        • RemoveFromList Method
      • List
        • Element Property
        • AddNew Method
        • DeleteAll Method
        • Item Method
      • ListLevel
      • PlainText
        • Bottom Property
        • CharConfidence Property
        • IsSuspicious Property
        • Left Property
        • PageNumber Property
        • Right Property
        • Top Property
        • SaveToAsciiXMLFile Method
        • SaveToTextFile Method
      • BarcodeText
        • Element Property
        • Item Method
      • BarcodeSymbol
    • Document-Related Objects
      • FRDocument
        • AddImageDocument Method
        • AddImageFile Method
        • AddImageFileFromAttachment Method
        • AddImageFileFromMemory Method
        • AddImageFileFromStream Method
        • AddImageFileWithPassword Method
        • AddImageFileWithPasswordCallback Method
        • AddPage Method
        • Analyze Method
        • AnalyzePages Method
        • CheckTextLayer Method
        • Close Method
        • ConvertFromOldVersion Method
        • Export Method
        • ExportPages Method
        • ExportToMemory Method
        • LoadFromFolder Method
        • Preprocess Method
        • PreprocessPages Method
        • Process Method
        • ProcessPages Method
        • Recognize Method
        • RecognizePages Method
        • SaveToFolder Method
        • SplitPages Method
        • Synthesize Method
        • SynthesizePages Method
      • FRPages
        • Element Property
        • DeleteAt Method
        • IndexOf Method
        • Item Method
        • Renumber Method
        • Swap Method
      • FRPage
        • AddWordsToCacheDictionary Method
        • AddWordToCacheDictionary Method
        • Analyze Method
        • AnalyzeRegion Method
        • AnalyzeTable Method
        • CleanCacheDictionary Method
        • CorrectGeometricalDistortions Method
        • DetectOrientation Method
        • DetectResolution Method
        • Export Method
        • ExtractBarcodes Method
        • ExtractMrz Method
        • FindPageSplitPosition Method
        • Flush Method
        • IsEmpty Method
        • LearnCheckmarks Method
        • Preprocess Method
        • PreprocessAnalyzeRecognize Method
        • Recognize Method
        • RecognizeBlocks Method
        • Redo Method
        • Synthesize Method
        • SynthesizeBusinessCard Method
        • SynthesizeBusinessCardEx Method
        • Undo Method
        • Update Method
      • IFRDocumentEvents
        • OnPageProcessed Method
        • OnProgress Method
        • OnWarning Method
      • IFRPagesEvents
        • PageAdded Method
        • PageRemoved Method
        • PagesRenumbered Method
      • IFRPageEvents
        • OnPageProcessed Method
        • OnProgress Method
        • OnRegionProcessed Method
        • OnWarning Method
      • BusinessCards
        • Element Property
        • Item Method
      • BusinessCard
        • Field Property
        • FieldByType Property
        • FieldsCountByType Property
        • ExportToVCard Method
      • BusinessCardField
        • Component Property
        • FindComponent Method
        • GetCharParams Method
      • BusinessCardFieldComponent
        • GetCharParams Method
      • MrzData
        • GetField Method
        • GetFieldByType Method
        • GetLine Method
        • ExportToFile Method
        • ExportToFileEx Method
      • MrzField
        • GetCharParams Method
        • Insert Method
        • Remove Method
      • MrzLine
      • DocumentInformationDictionary
        • Value Property
        • AddNew Method
        • DeleteAll Method
        • DeleteAt Method
        • Item Method
      • DocumentInformationDictionaryItem
      • DocumentContentInfo
      • AuthorsList
        • Element Property
        • AddNew Method
        • DeleteAll Method
        • DeleteAt Method
        • Item Method
      • AuthorInfo
        • IsValid Method
        • CopyFrom Method
      • PDFAttachments
        • AddFromFile Method
        • DeleteAll Method
        • DeleteAt Method
        • Item Method
      • PDFAttachment
        • SaveToFile Method
    • Batch Processor
      • BatchProcessor
        • GetNextProcessedPage Method
        • ProcessPageAsync Method
        • Start Method
      • IImageSource
        • GetNextImageDocument Method
        • GetNextImageFile Method
        • IsEmpty Method
      • IFileAdapter
        • GetFileName Method
        • GetPagesToProcess Method
        • GetPassword Method
      • IAsyncProcessingCallback
        • OnError Method
        • OnProgress Method
    • Mechanism Objects
      • ExportFileWriter
        • AddPage Method
        • AddPages Method
        • Close Method
    • Parameter Objects
      • MultiProcessingParams
      • Preprocessing, Analysis, Recognition, and Synthesis Parameters
        • DocumentProcessingParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • PageSplittingParams
        • PageProcessingParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • PagePreprocessingParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • MrzProcessingParams
        • OrientationDetectionParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • ColorObjectsProhibitingParams
        • SortingBlocksParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • PageAnalysisParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • TableAnalysisParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • BarcodeParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • ObjectsExtractionParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • RecognizerParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
          • SetPredefinedTextLanguage Method
        • SynthesisParamsForPage
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • SynthesisParamsForDocument
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • BusinessCardSynthesisParams
        • DocumentStructureDetectionParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • FontFormattingDetectionParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • EmptyPageDetectionParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • FontSet
        • SystemFontSet
        • CustomFontSet
      • Export Parameters
        • HTMLExportParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • PPTExportParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • RTFExportParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • TextExportParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • XLExportParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • XMLExportParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • AltoExportParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • EBookExportParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • XPSExportParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • PaperSizeParams
        • PictureExportParams
        • PDFExportParams
          • CopyFrom Method
          • LoadFromFile Method
          • SaveToFile Method
        • PDFExportFeatures
        • PDFEncryptionInfo
        • PDFPictureCompressionParams
        • PDFMRCParams
        • PictureResolutionParams
        • DocumentContentInfoWritingParams
        • TextLayerInjectionParams
        • MrzJsonExportParams
        • MrzXmlExportParams
        • PageMargins
        • PDFPictures
          • AddNew Method
          • DeleteAll Method
          • DeleteAt Method
          • Element Property
          • Item Method
        • PDFPicture
          • GetLocation Method
          • RemoveFromPage Method
          • SetLocation Method
    • Classification-Related Objects
      • ClassificationEngine
        • CreateModelFromFile Method
        • CreateObjectFromDocument Method
        • CreateObjectFromPage Method
        • CreateTrainer Method
        • CreateTrainingData Method
      • Trainer
        • TrainModel Method
      • Model
        • Classify Method
        • SaveToFile Method
      • ClassificationResults
        • Element Property
        • Item Method
      • ClassificationResult
      • TrainingResults
        • Element Property
        • Item Method
      • TrainingResult
      • ValidationResult
      • ConfusionMatrix
        • Element Property
      • TrainingParams
      • ValidationParams
      • TrainingData
        • LoadFromFile Method
        • SaveToFile Method
      • Categories
        • Element Property
        • AddNew Method
        • DeleteAll Method
        • DeleteAt Method
        • Find Method
        • Item Method
      • Category
      • ClassificationObjects
        • Element Property
        • Add Method
        • DeleteAll Method
        • DeleteAt Method
        • Find Method
        • Item Method
      • ClassificationObject
    • License-Related Objects
      • License
        • Volume Property
        • VolumeRefreshingPeriod Property
        • VolumeRefreshingDate Method
        • VolumeRemaining Property
        • ExpirationDate Method
      • Licenses
        • Element Property
        • Find Method
        • Item Method
      • ILicensingConnectionRecoveryCallback
        • OnDisconnect Method
    • Document Comparison Objects
      • Comparator
        • CompareDocuments Method
        • ComparePages Method
      • ComparisonParams
      • ComparisonResult
        • Export Method
        • GetChangesForReferencePage Method
        • GetChangesForUserPage Method
      • Changes
        • Element Property
        • Item Method
      • Change
        • GetAsPictureChange Method
        • GetAsTextChange Method
      • ChangeLocation
        • RegionForPage Property
      • ChangePosition
      • PictureChange
      • TextChange
    • Supplementary Objects and Methods
      • StringsCollection
        • Element Property
        • Add Method
        • CopyFrom Method
        • DeleteAll Method
        • DeleteAt Method
        • InsertAt Method
        • Item Method
      • IntsCollection
        • Element Property
        • Add Method
        • CopyFrom Method
        • DeleteAll Method
        • DeleteAt Method
        • InsertAt Method
        • Item Method
      • SplitRegions
        • Element Property
        • GetSourcePageIndex Method
        • Item Method
      • SplitRegion
      • Region
        • Bottom Property
        • Left Property
        • Right Property
        • Top Property
        • AddRect Method
        • AddRegion Method
        • CopyFrom Method
        • CutRect Method
        • HasIntersectionWithRect Method
        • HasIntersectionWithRegion Method
        • IsEqual Method
        • IsPointInRegion Method
        • IsRectInRegion Method
        • IsRegionInRegion Method
        • LoadFromFile Method
        • MakeEmpty Method
        • SaveToFile Method
      • RegionsCollection
        • Element Property
        • Add Method
        • DeleteAll Method
        • DeleteAt Method
        • InsertAt Method
        • Item Method
      • FRRectangle
        • CopyFrom Method
        • SetRectangle Method
        • SetRectangleFromLTRB Method
      • Point
        • CopyFrom Method
        • SetPoint Method
      • Handle
        • CloseHandle Method
        • Detach Method
      • IReadStream
        • Close Method
        • Read Method
      • IWriteStream
        • Write Method
      • IFileWriter
        • Close Method
        • Open Method
        • Write Method
      • IParallelProcessingCallback
        • OnWaitIntervalExceeded Method
      • IProcessingEvents
        • OnPageProcessed Method
        • OnProgress Method
        • OnWarning Method
      • Add Method
      • AddNew Method
      • CopyFrom Method
      • DeleteAll Method
      • DeleteAt Method
      • Element Property
      • Item Method
      • LoadFromFile Method
      • SaveToFile Method
    • Enumerations
      • AltoVersionEnum
      • AvailableBarcodeModulesFlags
      • AvailableEngineModulesFlags
      • AvailableExportFormatsFlags
      • AvailableLanguageSetsFlags
      • AvailableTextTypesFlags
      • AveragingMethodEnum
      • BackgroundColorModeEnum
      • BarcodeOrientationEnum
      • BarcodeSupplementTypeEnum
      • BarcodeTypeEnum
      • BaseLanguageLetterSetEnum
      • BitmapBitsFormatEnum
      • BlockLayerTypeEnum
      • BlockRoleEnum
      • BlockTypeEnum
      • BusinessCardFieldComponentTypeEnum
      • BusinessCardFieldTypeEnum
      • BwPictureFormatsEnum
      • CaseRecognitionModeEnum
      • CharacterFlags
      • CheckingTextModeEnum
      • CheckmarkCheckStateEnum
      • CheckmarkTypeEnum
      • ClassifierTypeEnum
      • CodePageEnum
      • ColorPictureFormatsEnum
      • ComparatorExportFormatEnum
      • CorrectSkewModeEnum
      • DetectColorRegionFlags
      • DictionaryTypeEnum
      • DitheringMethodEnum
      • DocumentChangeTypeEnum
      • FieldMarkingTypeEnum
      • FileExportFormatEnum
      • FontEmbeddingModeEnum
      • FontFormattingModeEnum
      • FontNamesFiltersEnum
      • FontTypeEnum
      • FREngineModuleEnum
      • FREngineVersionEnum
      • GapMeasurementUnitEnum
      • GrayPictureFormatsEnum
      • HTMLDocumentSplittingModeEnum
      • HTMLFormatModeEnum
      • HTMLSynthesisModeEnum
      • HyperlinkSchemeEnum
      • ImageColorTypeEnum
      • ImageFileFormatEnum
      • ImageTypeEnum
      • LanguageCategoryEnum
      • LanguageIdEnum
      • LicenseCounterTypeEnum
      • MessagesLanguageEnum
      • ModificationTypeEnum
      • MonospaceDetectionModeEnum
      • MrzExportFormatEnum
      • MrzFieldTypeEnum
      • MrzFormatEnum
      • MultiProcessingModeEnum
      • NoiseModelEnum
      • NumberingStyleEnum
      • ObjectsColorEnum
      • ObjectsTypeEnum
      • OfficeConverterTypeEnum
      • OrientationDetectionModeEnum
      • PageFlushingPolicyEnum
      • PageOrientationEnum
      • PageProcessingStageEnum
      • PageSplitDirectionEnum
      • PageSplitTypeEnum
      • PaperSizeDetectionModeEnum
      • PaperSizeModeEnum
      • ParagraphAlignmentEnum
      • ParagraphExtractionModeEnum
      • ParagraphRoleEnum
      • ParagraphTabAlignmentEnum
      • PDFAComplianceModeEnum
      • PDFAttachmentBindingEnum
      • PDFEncryptionAlgorithmEnum
      • PDFExportModeEnum
      • PDFExportScenarioEnum
      • PDFKeyLengthEnum
      • PDFMRCModeEnum
      • PDFResolutionTypeEnum
      • PDFVersionEnum
      • PhotoProcessingModeEnum
      • PictureColorityModeEnum
      • QueuePushingModeEnum
      • ReadingTypeEnum
      • RecognitionModeEnum
      • RemoveGarbageRegionFlags
      • RotationTypeEnum
      • RTFPageSynthesisModeEnum
      • SeparatorTypeEnum
      • SkewCorrectionModeEnum
      • SourceContentReuseModeEnum
      • StyleParamsEnum
      • TabLeaderTypeEnum
      • TableSeparatorTypeEnum
      • TextAndBackgroundColorModeEnum
      • TextCategoryEnum
      • TextEncodingTypeEnum
      • TextLanguageLetterSetEnum
      • TextLayoutRetentionModeEnum
      • TextTypeEnum
      • ThreeStatePropertyValueEnum
      • TimeoutHandlingModeEnum
      • TimeZoneTypeEnum
      • TrainingModeEnum
      • TXTExportFormatEnum
      • UserPatternsTrainingFlags
      • VolumeRefreshingPeriodEnum
      • WordModelTypeEnum
      • WriteDateEnum
      • WritingStyleEnum
      • XLFileFormatEnum
      • XLSXLayoutRetentionModeEnum
      • XLSXPaperSizeEnum
      • XMLCharAttributesEnum
      • XPSExportModeEnum
    • Return Codes
  • Licensing
    • Activation
    • License Manager Utility
      • Working from the Command Line
    • Working with the LicensingSettings.xml File
    • Online Licensing
    • Modules
    • Installing the Wibu CodeMeter Drivers
    • Counter Increasing Methods
    • Copyright and Trademark Notices
    • Minimum Terms of EULA
  • Distribution
    • Installing the Library
    • Activating the Library
      • Installing the Licensing Service
    • Distribution Kit
      • Distribution Kit: PDF
      • Working with the FREngineDistribution.csv File
    • Running ABBYY FineReader Engine 12 inside a Docker container
  • Specifications
    • Supported Image Formats
    • Supported Digital Document Input Formats
    • Predefined Languages
    • Text Types
    • Barcode Types
    • Machine-Readable Zone Fields
    • Export Formats
      • XML Schema Description
      • XML Schema for Comparison Result
      • XML Schema for MRZ
      • JSON file for MRZ
    • Predefined Profiles Specification
    • What's New
    • Backward Compatibility Issues
      • Version 11
      • Version 10
        • Business Cards API
        • Functions
        • Engine Object
          • Engine for Java
        • Image-Related Objects
        • Layout-Related Objects
        • Language-Related Objects
        • Text-Related Objects
        • Document-Related Objects
        • Batch Processor
        • Mechanism Objects
        • Parameter Objects
        • License-Related Objects
        • Supplementary Objects
    • Differences between ABBYY FineReader Engine for Windows and Linux
    • Documentation Changes
    • System Requirements
  • Frequently Asked Questions
  • Contact ABBYY
    • How to Buy
    • Technical Support
Chinese Simplified (简体中文)
  • English (English)

Hyperlink Object (IHyperlink Interface)

This object exposes method and properties of a hyperlink.

Properties

Name Type Description
Application Engine, read-only Returns the Engine object.
Scheme HyperlinkSchemeEnum Stores the hyperlink type which is detected automatically when the Target property is assigned a hyperlink address. If the value of the IHyperlink::Scheme property is HS_Unknown, the type of the hyperlink assigned to the Target property will be detected automatically.
Target BSTR Stores the hyperlink address. If the link is local, use the user bookmark as Target and HS_Local as Scheme (see the example below).

Methods

Name Description
ParseTarget Brings the Target property to the canonical form, according to the types described in HyperlinkSchemeEnum.

Related objects

Object Diagram

Output parameter

This object is the output parameter of the CreateHyperlink method of the Engine object.

Input parameter

This object is the input parameter of the SetHyperlink method of the Paragraph object.

Samples

C++ code

// Create bookmark
paragraph1->SetBookmark( 0, count, L"my_user_bookmark" ) ;
// Create hyperlink
CSafePtr<IHyperlink> newHyperlink;
FREngine->CreateHyperlink( &newHyperlink ) ;
newHyperlink->put_Scheme( HS_Local ) ;
newHyperlink->put_Target( L"UserDefinedBookmark:my_user_bookmark" ) ;
paragraph2->SetHyperlink( 0, count, newHyperlink );
...
        

See also

Working with Text

Working with Properties

03.07.2024 8:50:25

© 2025 ABBYY. All rights reserved.
  • Privacy Policy
  • Cookie Policy
  • Legal
  • Cookie management
  • Vulnerability disclosure
  • ABBYY corporate website
Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.