Class PdfRedactionAnnotation

Namespace

Syncfusion.Pdf.Interactive

Assembly

Syncfusion.Pdf.Portable.dll

Represents the PdfRedactionAnnotation.

public class PdfRedactionAnnotation : PdfAnnotation, INotifyPropertyChanged

Inheritance

object

PdfAnnotation

PdfRedactionAnnotation

Implements

INotifyPropertyChanged

Inherited Members

PdfAnnotation.SetAppearance(bool)

PdfAnnotation.CalculateBounds(RectangleF, PdfPage, PdfLoadedPage)

PdfAnnotation.SetValues(string, string)

PdfAnnotation.CalculateTemplateBounds(RectangleF, PdfPageBase, PdfTemplate)

PdfAnnotation.CalculateTemplateBounds(RectangleF, PdfPageBase, PdfTemplate, bool, PdfGraphics)

PdfAnnotation.CalculateTemplateBounds(RectangleF, PdfPageBase, PdfTemplate, bool)

PdfAnnotation.CheckFlatten()

PdfAnnotation.Color

PdfAnnotation.Opacity

PdfAnnotation.InnerColor

PdfAnnotation.Bounds

PdfAnnotation.Location

PdfAnnotation.Size

PdfAnnotation.Page

PdfAnnotation.Text

PdfAnnotation.Author

PdfAnnotation.Subject

PdfAnnotation.ModifiedDate

PdfAnnotation.AnnotationFlags

PdfAnnotation.FlattenPopUps

PdfAnnotation.PdfTag

PdfAnnotation.Layer

PdfAnnotation.Rotate

PdfAnnotation.Name

PdfAnnotation.PropertyChanged

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

 //Create a new PDF document.
 PdfDocument doc = new PdfDocument();
 //Create a new page.
 PdfPage page = doc.Pages.Add();
 //Creates a new Redaction annotation.
 PdfRedactionAnnotation annot = new PdfRedactionAnnotation();
 //set the bounds
 annot.Bounds = new Rectangle(100, 120, 100, 100);
 //set the innercolor
annot.InnerColor = Color.Aqua;
 //set the bordercolor
 annot.BorderColor = Color.Orange;
 //set the textcolor
 annot.TextColor = Color.Yellow;
 //set the font
 annot.Font = new PdfStandardFont(PdfFontFamily.Helvetica, 10);
 //set overlaytext
 annot.OverlayText = "Redact";
 //set textalignment
annot.TextAlignment = PdfTextAlignment.Right; 
 annot.Repeat = true;
 annot.SetAppearance(true);
 ////Add the annotation to the page.
 page.Annotations.Add(annot);
 //Saves the document to disk.
 doc.Save("empty.pdf");
 doc.Close(true);
 System.Diagnostics.Process.Start("empty.pdf");

 //Create a new PDF document.
Dim doc As PdfDocument = New PdfDocument()
//Create a new page.
Dim page As PdfPage = doc.Pages.Add()
//Creates a new Redaction annotation.
Dim annot As PdfRedactionAnnotation = New PdfRedactionAnnotation()
//set the bounds
annot.Bounds = New Rectangle(100, 120, 100, 100)
//set the innercolor
annot.InnerColor = Color.Aqua
//set the bordercolor
annot.BorderColor = Color.Orange
//set the textcolor
annot.TextColor = Color.Yellow
annot.Font = New PdfStandardFont(PdfFontFamily.Helvetica, 10)
annot.OverlayText = "Redact"
annot.TextAlignment = PdfTextAlignment.Right
annot.Repeat = True
annot.SetAppearance(True)
page.Annotations.Add(annot)
//Saves the document to disk.
doc.Save("empty.pdf")
doc.Close(True)
System.Diagnostics.Process.Start("empty.pdf");

Constructors

PdfRedactionAnnotation()

Initialize the new instance of the redaction annotation.

public PdfRedactionAnnotation()

Properties

Border

Get or set the border of redaction annotation

public LineBorder Border { get; set; }

Property Value

LineBorder

Examples

 //Create a new PDF document.
 PdfDocument doc = new PdfDocument();
 //Create a new page.
 PdfPage page = doc.Pages.Add();
 //Creates a new Redaction annotation.
 PdfRedactionAnnotation annot = new PdfRedactionAnnotation();
 //set the bounds
 annot.Bounds = new Rectangle(100, 120, 100, 100);
 //set the innercolor
annot.InnerColor = Color.Aqua;
 //set the bordercolor
 annot.BorderColor = Color.Orange;
 //set the textcolor
 annot.TextColor = Color.Yellow;
 //set the font
 annot.Font = new PdfStandardFont(PdfFontFamily.Helvetica, 10);
 //set overlaytext
 annot.OverlayText = "Redact";
 //set textalignment
annot.TextAlignment = PdfTextAlignment.Right; 
 annot.Repeat = true;
 annot.SetAppearance(true);
 ////Add the annotation to the page.
 page.Annotations.Add(annot);
 //Saves the document to disk.
 doc.Save("empty.pdf");
 doc.Close(true);
 System.Diagnostics.Process.Start("empty.pdf");

 //Create a new PDF document.
Dim doc As PdfDocument = New PdfDocument()
//Create a new page.
Dim page As PdfPage = doc.Pages.Add()
//Creates a new Redaction annotation.
Dim annot As PdfRedactionAnnotation = New PdfRedactionAnnotation()
//set the bounds
annot.Bounds = New Rectangle(100, 120, 100, 100)
//set the innercolor
annot.InnerColor = Color.Aqua
//set the bordercolor
annot.BorderColor = Color.Orange
//set the textcolor
annot.TextColor = Color.Yellow
annot.Font = New PdfStandardFont(PdfFontFamily.Helvetica, 10)
annot.OverlayText = "Redact"
annot.TextAlignment = PdfTextAlignment.Right
annot.Repeat = True
annot.SetAppearance(True)
page.Annotations.Add(annot)
//Saves the document to disk.
doc.Save("empty.pdf")
doc.Close(True)
System.Diagnostics.Process.Start("empty.pdf");

BorderColor

Get or set the bordercolor of redaction annotation

public PdfColor BorderColor { get; set; }

Property Value

PdfColor

Examples

 //Create a new PDF document.
 PdfDocument doc = new PdfDocument();
 //Create a new page.
 PdfPage page = doc.Pages.Add();
 //Creates a new Redaction annotation.
 PdfRedactionAnnotation annot = new PdfRedactionAnnotation();
 //set the bounds
 annot.Bounds = new Rectangle(100, 120, 100, 100);
 //set the innercolor
annot.InnerColor = Color.Aqua;
 //set the bordercolor
 annot.BorderColor = Color.Orange;
 //set the textcolor
 annot.TextColor = Color.Yellow;
 //set the font
 annot.Font = new PdfStandardFont(PdfFontFamily.Helvetica, 10);
 //set overlaytext
 annot.OverlayText = "Redact";
 //set textalignment
annot.TextAlignment = PdfTextAlignment.Right; 
 annot.Repeat = true;
 annot.SetAppearance(true);
 ////Add the annotation to the page.
 page.Annotations.Add(annot);
 //Saves the document to disk.
 doc.Save("empty.pdf");
 doc.Close(true);
 System.Diagnostics.Process.Start("empty.pdf");

 //Create a new PDF document.
Dim doc As PdfDocument = New PdfDocument()
//Create a new page.
Dim page As PdfPage = doc.Pages.Add()
//Creates a new Redaction annotation.
Dim annot As PdfRedactionAnnotation = New PdfRedactionAnnotation()
//set the bounds
annot.Bounds = New Rectangle(100, 120, 100, 100)
//set the innercolor
annot.InnerColor = Color.Aqua
//set the bordercolor
annot.BorderColor = Color.Orange
//set the textcolor
annot.TextColor = Color.Yellow
annot.Font = New PdfStandardFont(PdfFontFamily.Helvetica, 10)
annot.OverlayText = "Redact"
annot.TextAlignment = PdfTextAlignment.Right
annot.Repeat = True
annot.SetAppearance(True)
page.Annotations.Add(annot)
//Saves the document to disk.
doc.Save("empty.pdf")
doc.Close(True)
System.Diagnostics.Process.Start("empty.pdf");

Flatten

Get or set flatten of redaction annotation

public bool Flatten { get; set; }

Property Value

bool

Examples

 //Create a new PDF document.
 PdfDocument doc = new PdfDocument();
 //Create a new page.
 PdfPage page = doc.Pages.Add();
 //Creates a new Redaction annotation.
 PdfRedactionAnnotation annot = new PdfRedactionAnnotation();
 //set the bounds
 annot.Bounds = new Rectangle(100, 120, 100, 100);
 //set the innercolor
annot.InnerColor = Color.Aqua;
 //set the bordercolor
 annot.BorderColor = Color.Orange;
 //set the textcolor
 annot.TextColor = Color.Yellow;
 //set the font
 annot.Font = new PdfStandardFont(PdfFontFamily.Helvetica, 10);
 //set overlaytext
 annot.OverlayText = "Redact";
 //set textalignment
annot.TextAlignment = PdfTextAlignment.Right; 
 annot.Repeat = true;
 annot.Flatten=true;
 ////Add the annotation to the page.
 page.Annotations.Add(annot);
 //Saves the document to disk.
 doc.Save("empty.pdf");
 doc.Close(true);
 System.Diagnostics.Process.Start("empty.pdf");

 //Create a new PDF document.
Dim doc As PdfDocument = New PdfDocument()
//Create a new page.
Dim page As PdfPage = doc.Pages.Add()
//Creates a new Redaction annotation.
Dim annot As PdfRedactionAnnotation = New PdfRedactionAnnotation()
//set the bounds
annot.Bounds = New Rectangle(100, 120, 100, 100)
//set the innercolor
annot.InnerColor = Color.Aqua
//set the bordercolor
annot.BorderColor = Color.Orange
//set the textcolor
annot.TextColor = Color.Yellow
annot.Font = New PdfStandardFont(PdfFontFamily.Helvetica, 10)
annot.OverlayText = "Redact"
annot.TextAlignment = PdfTextAlignment.Right
annot.Repeat = True
annot.Flatten=true;
page.Annotations.Add(annot)
//Saves the document to disk.
doc.Save("empty.pdf")
doc.Close(True)
System.Diagnostics.Process.Start("empty.pdf");

Font

Get or set the font of redaction annotation

public PdfFont Font { get; set; }

Property Value

PdfFont

Examples

 //Create a new PDF document.
 PdfDocument doc = new PdfDocument();
 //Create a new page.
 PdfPage page = doc.Pages.Add();
 //Creates a new Redaction annotation.
 PdfRedactionAnnotation annot = new PdfRedactionAnnotation();
 //set the bounds
 annot.Bounds = new Rectangle(100, 120, 100, 100);
 //set the innercolor
annot.InnerColor = Color.Aqua;
 //set the bordercolor
 annot.BorderColor = Color.Orange;
 //set the textcolor
 annot.TextColor = Color.Yellow;
 //set the font
 annot.Font = new PdfStandardFont(PdfFontFamily.Helvetica, 10);
 //set overlaytext
 annot.OverlayText = "Redact";
 //set textalignment
annot.TextAlignment = PdfTextAlignment.Right; 
 annot.Repeat = true;
 annot.SetAppearance(true);
 ////Add the annotation to the page.
 page.Annotations.Add(annot);
 //Saves the document to disk.
 doc.Save("empty.pdf");
 doc.Close(true);
 System.Diagnostics.Process.Start("empty.pdf");

 //Create a new PDF document.
Dim doc As PdfDocument = New PdfDocument()
//Create a new page.
Dim page As PdfPage = doc.Pages.Add()
//Creates a new Redaction annotation.
Dim annot As PdfRedactionAnnotation = New PdfRedactionAnnotation()
//set the bounds
annot.Bounds = New Rectangle(100, 120, 100, 100)
//set the innercolor
annot.InnerColor = Color.Aqua
//set the bordercolor
annot.BorderColor = Color.Orange
//set the textcolor
annot.TextColor = Color.Yellow
annot.Font = New PdfStandardFont(PdfFontFamily.Helvetica, 10)
annot.OverlayText = "Redact"
annot.TextAlignment = PdfTextAlignment.Right
annot.Repeat = True
annot.SetAppearance(True)
page.Annotations.Add(annot)
//Saves the document to disk.
doc.Save("empty.pdf")
doc.Close(True)
System.Diagnostics.Process.Start("empty.pdf");

OverlayText

Get or set the overlaytext of redaction annotation

public string OverlayText { get; set; }

Property Value

string

Examples

 //Create a new PDF document.
 PdfDocument doc = new PdfDocument();
 //Create a new page.
 PdfPage page = doc.Pages.Add();
 //Creates a new Redaction annotation.
 PdfRedactionAnnotation annot = new PdfRedactionAnnotation();
 //set the bounds
 annot.Bounds = new Rectangle(100, 120, 100, 100);
 //set the innercolor
annot.InnerColor = Color.Aqua;
 //set the bordercolor
 annot.BorderColor = Color.Orange;
 //set the textcolor
 annot.TextColor = Color.Yellow;
 //set the font
 annot.Font = new PdfStandardFont(PdfFontFamily.Helvetica, 10);
 //set overlaytext
 annot.OverlayText = "Redact";
 //set textalignment
annot.TextAlignment = PdfTextAlignment.Right; 
 annot.Repeat = true;
 annot.SetAppearance(true);
 ////Add the annotation to the page.
 page.Annotations.Add(annot);
 //Saves the document to disk.
 doc.Save("empty.pdf");
 doc.Close(true);
 System.Diagnostics.Process.Start("empty.pdf");

 //Create a new PDF document.
Dim doc As PdfDocument = New PdfDocument()
//Create a new page.
Dim page As PdfPage = doc.Pages.Add()
//Creates a new Redaction annotation.
Dim annot As PdfRedactionAnnotation = New PdfRedactionAnnotation()
//set the bounds
annot.Bounds = New Rectangle(100, 120, 100, 100)
//set the innercolor
annot.InnerColor = Color.Aqua
//set the bordercolor
annot.BorderColor = Color.Orange
//set the textcolor
annot.TextColor = Color.Yellow
annot.Font = New PdfStandardFont(PdfFontFamily.Helvetica, 10)
annot.OverlayText = "Redact"
annot.TextAlignment = PdfTextAlignment.Right
annot.Repeat = True
annot.SetAppearance(True)
page.Annotations.Add(annot)
//Saves the document to disk.
doc.Save("empty.pdf")
doc.Close(True)
System.Diagnostics.Process.Start("empty.pdf");

RepeatText

Get or set the text repeat of redaction annotation

public bool RepeatText { get; set; }

Property Value

bool

Examples

 //Create a new PDF document.
 PdfDocument doc = new PdfDocument();
 //Create a new page.
 PdfPage page = doc.Pages.Add();
 //Creates a new Redaction annotation.
 PdfRedactionAnnotation annot = new PdfRedactionAnnotation();
 //set the bounds
 annot.Bounds = new Rectangle(100, 120, 100, 100);
 //set the innercolor
annot.InnerColor = Color.Aqua;
 //set the bordercolor
 annot.BorderColor = Color.Orange;
 //set the textcolor
 annot.TextColor = Color.Yellow;
 //set the font
 annot.Font = new PdfStandardFont(PdfFontFamily.Helvetica, 10);
 //set overlaytext
 annot.OverlayText = "Redact";
 //set textalignment
annot.TextAlignment = PdfTextAlignment.Right; 
 annot.Repeat = true;
 annot.SetAppearance(true);
 ////Add the annotation to the page.
 page.Annotations.Add(annot);
 //Saves the document to disk.
 doc.Save("empty.pdf");
 doc.Close(true);
 System.Diagnostics.Process.Start("empty.pdf");

 //Create a new PDF document.
Dim doc As PdfDocument = New PdfDocument()
//Create a new page.
Dim page As PdfPage = doc.Pages.Add()
//Creates a new Redaction annotation.
Dim annot As PdfRedactionAnnotation = New PdfRedactionAnnotation()
//set the bounds
annot.Bounds = New Rectangle(100, 120, 100, 100)
//set the innercolor
annot.InnerColor = Color.Aqua
//set the bordercolor
annot.BorderColor = Color.Orange
//set the textcolor
annot.TextColor = Color.Yellow
annot.Font = New PdfStandardFont(PdfFontFamily.Helvetica, 10)
annot.OverlayText = "Redact"
annot.TextAlignment = PdfTextAlignment.Right
annot.RepeatText = True
annot.SetAppearance(True)
page.Annotations.Add(annot)
//Saves the document to disk.
doc.Save("empty.pdf")
doc.Close(True)
System.Diagnostics.Process.Start("empty.pdf");

TextAlignment

Get or set the textalignment of redaction annotation

public PdfTextAlignment TextAlignment { get; set; }

Property Value

PdfTextAlignment

Examples

 //Create a new PDF document.
 PdfDocument doc = new PdfDocument();
 //Create a new page.
 PdfPage page = doc.Pages.Add();
 //Creates a new Redaction annotation.
 PdfRedactionAnnotation annot = new PdfRedactionAnnotation();
 //set the bounds
 annot.Bounds = new Rectangle(100, 120, 100, 100);
 //set the innercolor
annot.InnerColor = Color.Aqua;
 //set the bordercolor
 annot.BorderColor = Color.Orange;
 //set the textcolor
 annot.TextColor = Color.Yellow;
 //set the font
 annot.Font = new PdfStandardFont(PdfFontFamily.Helvetica, 10);
 //set overlaytext
 annot.OverlayText = "Redact";
 //set textalignment
annot.TextAlignment = PdfTextAlignment.Right; 
 annot.Repeat = true;
 annot.SetAppearance(true);
 ////Add the annotation to the page.
 page.Annotations.Add(annot);
 //Saves the document to disk.
 doc.Save("empty.pdf");
 doc.Close(true);
 System.Diagnostics.Process.Start("empty.pdf");

 //Create a new PDF document.
Dim doc As PdfDocument = New PdfDocument()
//Create a new page.
Dim page As PdfPage = doc.Pages.Add()
//Creates a new Redaction annotation.
Dim annot As PdfRedactionAnnotation = New PdfRedactionAnnotation()
//set the bounds
annot.Bounds = New Rectangle(100, 120, 100, 100)
//set the innercolor
annot.InnerColor = Color.Aqua
//set the bordercolor
annot.BorderColor = Color.Orange
//set the textcolor
annot.TextColor = Color.Yellow
annot.Font = New PdfStandardFont(PdfFontFamily.Helvetica, 10)
annot.OverlayText = "Redact"
annot.TextAlignment = PdfTextAlignment.Right
annot.Repeat = True
annot.SetAppearance(True)
page.Annotations.Add(annot)
//Saves the document to disk.
doc.Save("empty.pdf")
doc.Close(True)
System.Diagnostics.Process.Start("empty.pdf");

TextColor

Get or set the textcolor of redaction annotation

public PdfColor TextColor { get; set; }

Property Value

PdfColor

Examples

 //Create a new PDF document.
 PdfDocument doc = new PdfDocument();
 //Create a new page.
 PdfPage page = doc.Pages.Add();
 //Creates a new Redaction annotation.
 PdfRedactionAnnotation annot = new PdfRedactionAnnotation();
 //set the bounds
 annot.Bounds = new Rectangle(100, 120, 100, 100);
 //set the innercolor
annot.InnerColor = Color.Aqua;
 //set the bordercolor
 annot.BorderColor = Color.Orange;
 //set the textcolor
 annot.TextColor = Color.Yellow;
 //set the font
 annot.Font = new PdfStandardFont(PdfFontFamily.Helvetica, 10);
 //set overlaytext
 annot.OverlayText = "Redact";
 //set textalignment
annot.TextAlignment = PdfTextAlignment.Right; 
 annot.Repeat = true;
 annot.SetAppearance(true);
 ////Add the annotation to the page.
 page.Annotations.Add(annot);
 //Saves the document to disk.
 doc.Save("empty.pdf");
 doc.Close(true);
 System.Diagnostics.Process.Start("empty.pdf");

 //Create a new PDF document.
Dim doc As PdfDocument = New PdfDocument()
//Create a new page.
Dim page As PdfPage = doc.Pages.Add()
//Creates a new Redaction annotation.
Dim annot As PdfRedactionAnnotation = New PdfRedactionAnnotation()
//set the bounds
annot.Bounds = New Rectangle(100, 120, 100, 100)
//set the innercolor
annot.InnerColor = Color.Aqua
//set the bordercolor
annot.BorderColor = Color.Orange
//set the textcolor
annot.TextColor = Color.Yellow
annot.Font = New PdfStandardFont(PdfFontFamily.Helvetica, 10)
annot.OverlayText = "Redact"
annot.TextAlignment = PdfTextAlignment.Right
annot.Repeat = True
annot.SetAppearance(True)
page.Annotations.Add(annot)
//Saves the document to disk.
doc.Save("empty.pdf")
doc.Close(True)
System.Diagnostics.Process.Start("empty.pdf");

Methods

Initialize()

Initializes annotation object.

protected override void Initialize()

Save()

Saves an annotation.

protected override void Save()