AnnTextHiliteObject Class

Summary

Defines an annotation hilite text review object.

Syntax

Objective-C

C++/CLI

Java

Python

public class AnnTextHiliteObject : AnnTextReviewObject

@interface LTAnnTextHiliteObject : LTAnnTextReviewObject

public class AnnTextHiliteObject extends AnnTextReviewObject

public: 
   ref class AnnTextHiliteObject : AnnTextReviewObject

class AnnTextHiliteObject(AnnTextReviewObject):

Remarks

AnnTextHiliteObject derives from AnnTextReviewObject and has a renderer that will fill each rectangle with the current Fill value. The constructor of this object will create a solid yellow brush and set it in Fill and sets the Opacity value to 0.5.

Text hilite is used by application such as Microsoft Word and Adobe Acrobat to mark part of the text in review mode. The LEADTOOLS Document Viewer uses text hilite for this purpose. It also stores any text notes added by the reviewer in the metadata of the AnnObject using the AnnObject.ContentMetadataKey key.

Programmatically, the boundaries and rectangles of the text hilite object can be controlled using the following properties:

Example

using Leadtools.Annotations.Automation; 
using Leadtools.Annotations.Engine; 
using Leadtools.Codecs; 
using Leadtools.Annotations; 
using Leadtools.Annotations.WinForms; 
 
public void AnnCore_AnnTextHiliteObject() 
{ 
   // assumes _automation is valid 
   double inch = 720.0; 
   // Add a TextHilite object 
   AnnTextHiliteObject textHiliteObj = new AnnTextHiliteObject(); 
   // Set the rectangle for the Text Hilite 
   textHiliteObj.AddRectangle(LeadRectD.Create(inch * 1, inch * 1, inch * 2, inch * 2)); 
   // Set the MetaData 
   textHiliteObj.Metadata[AnnObject.ContentMetadataKey] = "This is content"; 
   textHiliteObj.Metadata[AnnObject.AuthorMetadataKey] = Environment.UserName; 
   textHiliteObj.Metadata[AnnObject.CreatedMetadataKey] = DateTime.Now.ToString(); 
   // Add the object to the automation container 
   _automation.Container.Children.Add(textHiliteObj); 
}

Requirements

Target Platforms

Reference

AnnTextHiliteObject Members

Leadtools.Annotations.Engine Namespace

Download our FREE evaluation

Help Version 22.0.2023.7.31

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies