Class PdfLoadedRedactionAnnotation

Namespace

Syncfusion.Pdf.Interactive

Assembly

Syncfusion.Pdf.Portable.dll

Represents the PdfLoadedRedactionAnnotation.

public class PdfLoadedRedactionAnnotation : PdfLoadedStyledAnnotation, INotifyPropertyChanged

Inheritance

object

PdfAnnotation

PdfLoadedAnnotation

PdfLoadedStyledAnnotation

PdfLoadedRedactionAnnotation

Implements

INotifyPropertyChanged

Inherited Members

PdfLoadedStyledAnnotation.CheckFlatten()

PdfLoadedStyledAnnotation.FlattenAnnotationTemplate(PdfTemplate, bool)

PdfLoadedStyledAnnotation.Color

PdfLoadedStyledAnnotation.Opacity

PdfLoadedStyledAnnotation.InnerColor

PdfLoadedStyledAnnotation.Text

PdfLoadedStyledAnnotation.Author

PdfLoadedStyledAnnotation.Subject

PdfLoadedStyledAnnotation.ModifiedDate

PdfLoadedStyledAnnotation.Name

PdfLoadedStyledAnnotation.Bounds

PdfLoadedStyledAnnotation.Location

PdfLoadedStyledAnnotation.Size

PdfLoadedStyledAnnotation.AnnotationFlags

PdfLoadedAnnotation.ObjectID

PdfLoadedAnnotation.SetText(string)

PdfLoadedAnnotation.GetValues(string)

PdfLoadedAnnotation.SetValues(string, string)

PdfLoadedAnnotation.CreationDate

PdfLoadedAnnotation.Type

PdfLoadedAnnotation.Page

PdfAnnotation.SetAppearance(bool)

PdfAnnotation.Initialize()

PdfAnnotation.CalculateBounds(RectangleF, PdfPage, PdfLoadedPage)

PdfAnnotation.CalculateTemplateBounds(RectangleF, PdfPageBase, PdfTemplate)

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

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

PdfAnnotation.FlattenPopUps

PdfAnnotation.PdfTag

PdfAnnotation.Layer

PdfAnnotation.Rotate

PdfAnnotation.PropertyChanged

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

// PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Load the existing PdfLoadedRedactionAnnotation
//PdfLoadedRedactionAnnotation  annot = document.Pages[0].Annotations[0] as PdfLoadedRedactionAnnotation;
//Get the line ending style
// 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;
//Saves the document to disk.
//document.Save("redact.pdf");
//document.Close(true);
// System.Diagnostics.Process.Start("empty.pdf");

//Dim document As PdfLoadedDocument = New PdfLoadedDocument("..\..\Annotations.pdf")
//Dim annot As PdfLoadedRedactionAnnotation = TryCast(document.Pages(0).Annotations(0), PdfLoadedRedactionAnnotation)
//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 the textalignment
//annot.TextAlignment = PdfTextAlignment.Right
//annot.Repeat = True
//document.Save("redact.pdf")
//document.Close(True)
//System.Diagnostics.Process.Start("empty.pdf")
///

Properties

Border

Get or set the border of redaction annotation

public LineBorder Border { get; set; }

Property Value

LineBorder

Examples

///

// PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Load the existing PdfLoadedRedactionAnnotation
//PdfLoadedRedactionAnnotation  annot = document.Pages[0].Annotations[0] as PdfLoadedRedactionAnnotation;
//Get the line ending style
// 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;
//Saves the document to disk.
//document.Save("redact.pdf");
//document.Close(true);
// System.Diagnostics.Process.Start("empty.pdf");

//Dim document As PdfLoadedDocument = New PdfLoadedDocument("..\..\Annotations.pdf")
//Dim annot As PdfLoadedRedactionAnnotation = TryCast(document.Pages(0).Annotations(0), PdfLoadedRedactionAnnotation)
//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 the textalignment
//annot.TextAlignment = PdfTextAlignment.Right
//annot.Repeat = True
//document.Save("redact.pdf")
//document.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

///

// PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Load the existing PdfLoadedRedactionAnnotation
//PdfLoadedRedactionAnnotation  annot = document.Pages[0].Annotations[0] as PdfLoadedRedactionAnnotation;
//Get the line ending style
// 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;
//Saves the document to disk.
//document.Save("redact.pdf");
//document.Close(true);
// System.Diagnostics.Process.Start("empty.pdf");

//Dim document As PdfLoadedDocument = New PdfLoadedDocument("..\..\Annotations.pdf")
//Dim annot As PdfLoadedRedactionAnnotation = TryCast(document.Pages(0).Annotations(0), PdfLoadedRedactionAnnotation)
//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 the textalignment
//annot.TextAlignment = PdfTextAlignment.Right
//annot.Repeat = True
//document.Save("redact.pdf")
//document.Close(True)
//System.Diagnostics.Process.Start("empty.pdf")
///

Flatten

Get or set the flatten

public bool Flatten { get; set; }

Property Value

bool

Examples

///

// PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Load the existing PdfLoadedRedactionAnnotation
//PdfLoadedRedactionAnnotation  annot = document.Pages[0].Annotations[0] as PdfLoadedRedactionAnnotation;
//Get the line ending style
// 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
//Saves the document to disk.
//document.Save("redact.pdf");
//document.Close(true);
// System.Diagnostics.Process.Start("empty.pdf");

//Dim document As PdfLoadedDocument = New PdfLoadedDocument("..\..\Annotations.pdf")
//Dim annot As PdfLoadedRedactionAnnotation = TryCast(document.Pages(0).Annotations(0), PdfLoadedRedactionAnnotation)
//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 the textalignment
//annot.TextAlignment = PdfTextAlignment.Right
//annot.Repeat = True
//annot.Flatten=true;
//document.Save("redact.pdf")
//document.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

///

// PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Load the existing PdfLoadedRedactionAnnotation
//PdfLoadedRedactionAnnotation  annot = document.Pages[0].Annotations[0] as PdfLoadedRedactionAnnotation;
//Get the line ending style
// 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;
//Saves the document to disk.
//document.Save("redact.pdf");
//document.Close(true);
// System.Diagnostics.Process.Start("empty.pdf");

//Dim document As PdfLoadedDocument = New PdfLoadedDocument("..\..\Annotations.pdf")
//Dim annot As PdfLoadedRedactionAnnotation = TryCast(document.Pages(0).Annotations(0), PdfLoadedRedactionAnnotation)
//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 the textalignment
//annot.TextAlignment = PdfTextAlignment.Right
//annot.Repeat = True
//document.Save("redact.pdf")
//document.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

///

// PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Load the existing PdfLoadedRedactionAnnotation
//PdfLoadedRedactionAnnotation  annot = document.Pages[0].Annotations[0] as PdfLoadedRedactionAnnotation;
//Get the line ending style
// 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;
//Saves the document to disk.
//document.Save("redact.pdf");
//document.Close(true);
// System.Diagnostics.Process.Start("empty.pdf");

//Dim document As PdfLoadedDocument = New PdfLoadedDocument("..\..\Annotations.pdf")
//Dim annot As PdfLoadedRedactionAnnotation = TryCast(document.Pages(0).Annotations(0), PdfLoadedRedactionAnnotation)
//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 the textalignment
//annot.TextAlignment = PdfTextAlignment.Right
//annot.Repeat = True
//document.Save("redact.pdf")
//document.Close(True)
//System.Diagnostics.Process.Start("empty.pdf")
///

RepeatText

Get or set repeat text of redaction annotation

public bool RepeatText { get; set; }

Property Value

bool

Examples

///

// PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Load the existing PdfLoadedRedactionAnnotation
//PdfLoadedRedactionAnnotation  annot = document.Pages[0].Annotations[0] as PdfLoadedRedactionAnnotation;
//Get the line ending style
// 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;
//Saves the document to disk.
//document.Save("redact.pdf");
//document.Close(true);
// System.Diagnostics.Process.Start("empty.pdf");

//Dim document As PdfLoadedDocument = New PdfLoadedDocument("..\..\Annotations.pdf")
//Dim annot As PdfLoadedRedactionAnnotation = TryCast(document.Pages(0).Annotations(0), PdfLoadedRedactionAnnotation)
//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 the textalignment
//annot.TextAlignment = PdfTextAlignment.Right
//annot.Repeat = True
//document.Save("redact.pdf")
//document.Close(True)
//System.Diagnostics.Process.Start("empty.pdf")
///

TextAlignment

Get or set the text alignment of redaction annotation

public PdfTextAlignment TextAlignment { get; set; }

Property Value

PdfTextAlignment

Examples

///

// PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Load the existing PdfLoadedRedactionAnnotation
//PdfLoadedRedactionAnnotation  annot = document.Pages[0].Annotations[0] as PdfLoadedRedactionAnnotation;
//Get the line ending style
// 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;
//Saves the document to disk.
//document.Save("redact.pdf");
//document.Close(true);
// System.Diagnostics.Process.Start("empty.pdf");

//Dim document As PdfLoadedDocument = New PdfLoadedDocument("..\..\Annotations.pdf")
//Dim annot As PdfLoadedRedactionAnnotation = TryCast(document.Pages(0).Annotations(0), PdfLoadedRedactionAnnotation)
//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 the textalignment
//annot.TextAlignment = PdfTextAlignment.Right
//annot.Repeat = True
//document.Save("redact.pdf")
//document.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

// PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Load the existing PdfLoadedRedactionAnnotation
//PdfLoadedRedactionAnnotation  annot = document.Pages[0].Annotations[0] as PdfLoadedRedactionAnnotation;
//Get the line ending style
// 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;
//Saves the document to disk.
//document.Save("redact.pdf");
//document.Close(true);
// System.Diagnostics.Process.Start("empty.pdf");

//Dim document As PdfLoadedDocument = New PdfLoadedDocument("..\..\Annotations.pdf")
//Dim annot As PdfLoadedRedactionAnnotation = TryCast(document.Pages(0).Annotations(0), PdfLoadedRedactionAnnotation)
//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 the textalignment
//annot.TextAlignment = PdfTextAlignment.Right
//annot.Repeat = True
//document.Save("redact.pdf")
//document.Close(True)
//System.Diagnostics.Process.Start("empty.pdf")
///

Methods

Save()

Saves an annotation.

protected override void Save()