AnnTextUnderlineObject Object

Summary

Defines an annotation underline text review object.

Syntax
TypeScript
JavaScript
function lt.Annotations.Engine.AnnTextUnderlineObject 
	extends lt.Annotations.Engine.AnnTextReviewObject 
	implements IAnnObjectCloneable 
class lt.Annotations.Engine.AnnTextUnderlineObject() 
	extends 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.

TypeScript
JavaScript
// assumes _automation is valid 
var inch = 720.0; 
    
// Add a text underline object 
var annObj = new lt.Annotations.Engine.AnnTextUnderlineObject(); 
    
// Set the underline rectangles for the text underline object 
// Note that this object can be composed of multiple rectangles to underline them like underline specific lines of text 
// In this example we will create two rectangles 
var rectangles = [lt.LeadRectD.create(0, 0, 1 * inch, 0.5 * inch),lt.LeadRectD.create(0, 0.7 * inch, 1 * inch, 0.5 * inch)]; 
annObj.setRectangles(rectangles); 
    
// Add the object to the automation container 
this._automation.get_container().get_children().add(annObj); 
    
// Select the object 
this._automation.selectObject(annObj); 
// assumes _automation is valid 
const inch: number = 720.0; 
 
// Add a text underline object 
const annObj: lt.Annotations.Engine.AnnTextUnderlineObject = new lt.Annotations.Engine.AnnTextUnderlineObject(); 
 
// Set the underline rectangles for the text underline object 
// Note that this object can be composed of multiple rectangles to underline them like underline specific lines of text 
// In this example we will create two rectangles 
const rectangles: lt.LeadRectD[] = [lt.LeadRectD.create(0, 0, 1 * inch, 0.5 * inch), lt.LeadRectD.create(0, 0.7 * inch, 1 * inch, 0.5 * inch)]; 
annObj.setRectangles(rectangles); 
 
// Add the object to the automation container 
this._automation.container.children.add(annObj); 
 
// Select the object 
this._automation.selectObject(annObj); 

Requirements

Target Platforms

Help Version 20.0.2019.3.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations.Engine Assembly