AddRedactionRegion(Single,Single,Single,Single,Byte,Byte,Byte,Byte) Method

In This Topic

Adds redaction region on the selected page of the loaded PDF document.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Overloads Function AddRedactionRegion( _
   ByVal Left As Single, _
   ByVal Top As Single, _
   ByVal Width As Single, _
   ByVal Height As Single, _
   ByVal Red As Byte, _
   ByVal Green As Byte, _
   ByVal Blue As Byte, _
   ByVal Alpha As Byte _
) As GdPictureStatus

public GdPictureStatus AddRedactionRegion( 
   float Left,
   float Top,
   float Width,
   float Height,
   byte Red,
   byte Green,
   byte Blue,
   byte Alpha
)

public function AddRedactionRegion( 
    Left: Single;
    Top: Single;
    Width: Single;
    Height: Single;
    Red: Byte;
    Green: Byte;
    Blue: Byte;
    Alpha: Byte
): GdPictureStatus;

public function AddRedactionRegion( 
   Left : float,
   Top : float,
   Width : float,
   Height : float,
   Red : byte,
   Green : byte,
   Blue : byte,
   Alpha : byte
) : GdPictureStatus;

public: GdPictureStatus AddRedactionRegion( 
   float Left,
   float Top,
   float Width,
   float Height,
   byte Red,
   byte Green,
   byte Blue,
   byte Alpha
)

public:
GdPictureStatus AddRedactionRegion( 
   float Left,
   float Top,
   float Width,
   float Height,
   byte Red,
   byte Green,
   byte Blue,
   byte Alpha
)

Parameters

Left: The horizontal (X) coordinate of the closest point to the currently defined origin, where the redaction bounding box is to be located. The value is expressed in the current units specified by the SetMeasurementUnit method .
Top: The vertical (Y) coordinate of the closest point to the currently defined origin, where the redaction bounding box is to be located. The value is expressed in the current units specified by the SetMeasurementUnit method and it is related to the current page.
Width: The width of the redaction bounding box, expressed in the current units specified by the SetMeasurementUnit method.
Height: The height of the redaction bounding box, expressed in the current units specified by the SetMeasurementUnit method.
Red: The amount of red color to be used for the resulting region color. Use the value between 0 and 255.
Green: The amount of green color to be used for the resulting region color. Use the value between 0 and 255.
Blue: The amount of blue color to be used for the resulting region color. Use the value between 0 and 255.
Alpha: The transparency value of the resulting region color. Use the value between 0 (full transparency) and 255 (full opacity).

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks

This method is only allowed for use with non-encrypted documents.

Example

How to redact regions on pages in PDF document.

VB.NET
C#

Using gdpicturePDF As New GdPicturePDF
    gdpicturePDF.LoadFromFile("input.pdf")
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft)
    gdpicturePDF.SelectPage(1)
    gdpicturePDF.AddRedactionRegion(120, 300, 140, 20, 255, 0, 0, 255)
    gdpicturePDF.SelectPage(2)
    gdpicturePDF.AddRedactionRegion(100, 280, 70, 15, 0, 255, 0, 10)
    gdpicturePDF.AddRedactionRegion(100, 310, 70, 15, 0, 0, 255, 150)
    gdpicturePDF.ApplyRedaction()
    gdpicturePDF.SaveToFile("output.pdf")
End Using

using (GdPicturePDF gdpicturePDF = new GdPicturePDF())
{
    gdpicturePDF.LoadFromFile("input.pdf");
    gdpicturePDF.SetOrigin(PdfOrigin.PdfOriginTopLeft);
    gdpicturePDF.SelectPage(1);
    gdpicturePDF.AddRedactionRegion(120, 300, 140, 20, 255, 0, 0, 255);
    gdpicturePDF.SelectPage(2);
    gdpicturePDF.AddRedactionRegion(100, 280, 70, 15, 0, 255, 0, 10);
    gdpicturePDF.AddRedactionRegion(100, 310, 70, 15, 0, 0, 255, 150);
    gdpicturePDF.ApplyRedaction();
    gdpicturePDF.SaveToFile("output.pdf");
}

Reference

GdPicturePDF Class
GdPicturePDF Members
Overload List
ApplyRedaction Method
ClearRedactionRegions Method