JavaScript > JavaScript for Acrobat API Reference > JavaScript API > Annotation > Annotation properties > overlayText

overlayText
 
D
C
A text string specifying the overlay text that should be drawn over the redacted region after the affected content has been removed.
Type
String
Access
R/W
Annotations
Redact
Example
Set the redaction properties of a particular redaction annotation.
var a = this.getAnnots(); 							 	// get all annotations in doc
var r = a[0]			; 							 	// the first one is Redact type
r.setProps({ 										 	// now set its properties
	overlayText: " A.C. Robat ", 
	alignment: 0,
	repeat: true,
	fillColor:color.blue,
	textColor: color.green
});
There is a popup associated with a Redact annotation, now add content to this popup note.
r.setProps({ 					contents: "Shall we redact this paragraph?" });
See also the applyRedactions method of the Doc object.