AnnRedactionObject Object

Summary

Defines an annotation redaction object.

Syntax

JavaScript Syntax

function lt.Annotations.Core.AnnRedactionObject 
	extends lt.Annotations.Core.AnnRectangleObject 
	implements IAnnObjectCloneable

TypeScript Syntax

class lt.Annotations.Core.AnnRedactionObject() 
	extends lt.Annotations.Core.AnnRectangleObject 
	implements IAnnObjectCloneable

Remarks

The redaction annotation object is a rectangle with default properties that are appropriate for blacking out an area. The Realize method lets you block the area on the image with the current object brush value. The Restore method lets you restore the area back.

Programmatically, the boundaries and location of the redaction object can be controlled using the following properties: The AnnRedactionObject class inherits a number of properties from the AnnObject class, providing support for font, stroke and fill characteristics. These properties are listed below: The name of the redaction object can be controlled using Labels property, inherited from the AnnObject class. Each object can be transformed with the following methods: The following properties can also be used to programmatically set characteristics of an AnnRedactionObject:

Example

This example creates a redaction 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 redaction object 
   var redactObj = new lt.Annotations.Core.AnnRedactionObject(); 
   // Set the points for the rectangle 
   redactObj.get_points().add(lt.LeadPointD.create(1 * inch, 1 * inch)); 
   redactObj.get_points().add(lt.LeadPointD.create(2 * inch, 1 * inch)); 
   redactObj.get_points().add(lt.LeadPointD.create(2 * inch, 2 * inch)); 
   redactObj.get_points().add(lt.LeadPointD.create(1 * inch, 2 * inch)); 
   // Set the fill 
   redactObj.set_fill(lt.Annotations.Core.AnnSolidColorBrush.create("black")); 
   // Add the object to the automation container 
   this._automation.get_container().get_children().add(redactObj); 
   // Select the object 
   this._automation.selectObject(redactObj); 
},