AnnTextUnderlineObject Class

Summary

Defines an annotation underline text review object.

Syntax

Objective-C

C++/CLI

Java

Python

public class AnnTextUnderlineObject : AnnTextReviewObject

@interface LTAnnTextUnderlineObject : LTAnnTextReviewObject

public class AnnTextUnderlineObject extends AnnTextReviewObject

public: 
   ref class AnnTextUnderlineObject : AnnTextReviewObject

class AnnTextUnderlineObject(AnnTextReviewObject):

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 AnnObject.ContentMetadataKey key.

Programmatically, the boundaries and rectangles of the text underline 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_AnnTextUnderlineObject() 
{ 
   // assumes _automation is valid 
   double inch = 720.0; 
   // Add a TextUnderLine object 
   AnnTextUnderlineObject textUnderLineObj = new AnnTextUnderlineObject(); 
   // Set the rectangle for the Text UnderLine 
   textUnderLineObj.AddRectangle(LeadRectD.Create(inch * 1, inch * 1, inch * 2, inch * 2)); 
   // Set the MetaData 
   textUnderLineObj.Metadata[AnnObject.ContentMetadataKey] = "This is content"; 
   textUnderLineObj.Metadata[AnnObject.AuthorMetadataKey] = Environment.UserName; 
   textUnderLineObj.Metadata[AnnObject.CreatedMetadataKey] = DateTime.Now.ToString(); 
   // Add the object to the automation container 
   _automation.Container.Children.Add(textUnderLineObj); 
}

Requirements

Target Platforms

Reference

AnnTextUnderlineObject Members

Leadtools.Annotations.Engine Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies