AnnTextUnderlineObject Object

Summary

Defines an annotation underline text review object.

Syntax

JavaScript Syntax

function lt.Annotations.Core.AnnTextUnderlineObject 
	extends lt.Annotations.Core.AnnTextReviewObject 
	implements IAnnObjectCloneable

TypeScript Syntax

class lt.Annotations.Core.AnnTextUnderlineObject() 
	extends lt.Annotations.Core.AnnTextReviewObject 
	implements IAnnObjectCloneable

Remarks

AnnTextUnderlineObject derives from AnnTextReviewObject and has a renderer that will draw a thick horizontal line near the bottom of each rectangle using the current Fill value. The thickness and location of the line is a ratio of the height of each rectangle and can be controlled by the renderer. The constructor of this object will create a solid green brush and set it in Fill.

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

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

Example

This example creates a text underline object and adds it to the automation container.

JavaScript Example

example: function SiteLibrary_DefaultPage$example() 
{ 
   // assumes _automation is valid 
   var inch = 720.0; 
    
   // Add a text underline object 
   var annObj = new lt.Annotations.Core.AnnTextUnderlineObject(); 
    
   // Set the points for the hotspot 
   annObj.get_points().add(lt.LeadPointD.create(1 * inch, 1 * inch)); 
   annObj.get_points().add(lt.LeadPointD.create(2 * inch, 1 * inch)); 
   annObj.get_points().add(lt.LeadPointD.create(2 * inch, 2 * inch)); 
   annObj.get_points().add(lt.LeadPointD.create(1 * inch, 2 * inch)); 
    
   // Add the object to the automation container 
   this._automation.get_container().get_children().add(annObj); 
    
   // Select the object 
   this._automation.selectObject(annObj); 
}

Requirements

Target Platforms

Reference

AnnTextUnderlineObject Members

Leadtools.Annotations.Core Namespace

Help Version 19.0.2017.10.27

Leadtools.Annotations.Core Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Core Namespace

Assemblies