Class PdfLoadedRedactionAnnotation
Represents the PdfLoadedRedactionAnnotation.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Pdf.Interactive
Assembly: Syncfusion.Pdf.Portable.dll
Syntax
public class PdfLoadedRedactionAnnotation : PdfLoadedStyledAnnotation, IPdfWrapper, INotifyPropertyChanged
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
AppearanceFillColor
Get or set the appearance fill color of the redaction annotation.
Declaration
public PdfColor AppearanceFillColor { get; set; }
Property Value
| Type | Description |
|---|---|
| PdfColor | Returns a PdfColor representing the fill color used for the appearance of the redaction annotation. |
Examples
///
PdfLoadedDocument document = new PdfLoadedDocument(@"....\Annotations.pdf");
//Load the existing PdfLoadedRedactionAnnotation
PdfLoadedRedactionAnnotation annot = document.Pages[0].Annotations[0] as PdfLoadedRedactionAnnotation;
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 appearancefillcolor
annot.AppearanceFillColor = Color.HotPink;
//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);
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 appearancefillcolor
annot.AppearanceFillColor = Color.HotPink
//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)
Border
Get or set the border of redaction annotation
Declaration
public LineBorder Border { get; set; }
Property Value
| Type |
|---|
| 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
Declaration
public PdfColor BorderColor { get; set; }
Property Value
| Type |
|---|
| 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")
///
Comments
Gets the annotation Comments history.
Declaration
public PdfLoadedPopupAnnotationCollection Comments { get; }
Property Value
| Type | Description |
|---|---|
| PdfLoadedPopupAnnotationCollection | Returns a PdfPopupAnnotationCollection containing the comments associated with the annotation. |
Examples
//Load an existing document.
PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Load the existing PdfRedactionAnnotation
PdfLoadedRedactionAnnotation redact = document.Pages[0].Annotations[0] as PdfLoadedRedactionAnnotation;
//Get the Comments collection
PdfLoadedPopupAnnotationCollection CommentsCollection = redact.Comments;
//save the document
document.Save("PdfRedactionAnnotation.pdf");
//Close the docuemnt
document.Close(true);
'Load an existing document.
Dim document As New PdfLoadedDocument("..\..\Annotations.pdf")
'Load the existing PdfLoadedRedactionAnnotation
Dim redact As PdfLoadedRedactionAnnotation = document.Pages(0).Annotations(0)
'Get the Comments collection
Dim CommentsCollection As PdfLoadedPopupAnnotationCollection = redact.Comments
'save the document
document.Save("PdfRedactionAnnotation.pdf")
'Close the document.
document.Close(True)
See Also
Flatten
Get or set the flatten
Declaration
public bool Flatten { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
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
Declaration
public PdfFont Font { get; set; }
Property Value
| Type |
|---|
| 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
Declaration
public string OverlayText { get; set; }
Property Value
| Type |
|---|
| System.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
Declaration
public bool RepeatText { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
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")
///
ReviewHistory
Gets the annotation review history.
Declaration
public PdfLoadedPopupAnnotationCollection ReviewHistory { get; }
Property Value
| Type | Description |
|---|---|
| PdfLoadedPopupAnnotationCollection | Returns a PdfPopupAnnotationCollection containing the reviews associated with the annotation. |
Examples
//Load an existing document.
PdfLoadedDocument document = new PdfLoadedDocument(@"..\..\Annotations.pdf");
//Load the existing PdfLoadedRedactionAnnotation
PdfLoadedRedactionAnnotation redact = document.Pages[0].Annotations[0] as PdfLoadedRedactionAnnotation;
//Get the review collection
PdfLoadedPopupAnnotationCollection reviewCollection = rubber.ReviewHistory;
//save the document
document.Save("PdfRedactionAnnotation.pdf");
//Close the docuemnt
document.Close(true);
'Load an existing document.
Dim document As New PdfLoadedDocument("..\..\Annotations.pdf")
'Load the existing PdfLoadedRedactionAnnotation
Dim redact As PdfLoadedRedactionAnnotation = document.Pages(0).Annotations(0)
'Get the review collection
Dim reviewCollection As PdfLoadedPopupAnnotationCollection = redact.ReviewHistory
'save the document
document.Save("PdfRedactionAnnotation.pdf")
'Close the document.
document.Close(True)
See Also
TextAlignment
Get or set the text alignment of redaction annotation
Declaration
public PdfTextAlignment TextAlignment { get; set; }
Property Value
| Type |
|---|
| 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
Declaration
public PdfColor TextColor { get; set; }
Property Value
| Type |
|---|
| 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.
Declaration
protected override void Save()