API Reference
PdfRedactionRegion
Review geometry normalized into bounded areas that retain exact polygon or freehand geometry through planning, destructive application, verification, and evidence.
Inheritance
- Object
- PdfRedactionRegion
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
Accepted by parameters
- Method PdfDocumentRedactions.Plan
- Method PdfDocumentRedactions.Plan
- Constructor PdfRedactionAnnotationOptions.PdfRedactionAnnotationOptions
Methods
public static PdfRedactionRegion Freehand(Int32 pageNumber, IEnumerable<PdfRedactionPoint> points, Double strokeWidth, String label = null) #PdfRedactionRegionCreates an exact round-capped freehand region split into bounded path segments.
Parameters
- pageNumber System.Int32
- points System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfRedactionPoint}
- strokeWidth System.Double
- label System.String = null
public static PdfRedactionRegion FromRedactAnnotation(PdfAnnotation annotation) #PdfRedactionRegionCreates one atomic review region from a standard PDF /Redact annotation, honoring every valid /QuadPoints quadrilateral before falling back to /Rect.
Parameters
- annotation OfficeIMO.Pdf.PdfAnnotation
public static PdfRedactionRegion Group(Int32 pageNumber, IEnumerable<PdfRedactionArea> areas, String label = null) #PdfRedactionRegionGroups pre-normalized rectangles from one page into one review decision.
Parameters
- pageNumber System.Int32
- areas System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfRedactionArea}
- label System.String = null
public static PdfRedactionRegion Polygon(Int32 pageNumber, IEnumerable<PdfRedactionPoint> points, String label = null) #PdfRedactionRegionCreates an exact polygon.
Parameters
- pageNumber System.Int32
- points System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfRedactionPoint}
- label System.String = null
public static PdfRedactionRegion Quadrilateral(Int32 pageNumber, IEnumerable<PdfRedactionPoint> points, String label = null) #PdfRedactionRegionCreates an exact quadrilateral.
Parameters
- pageNumber System.Int32
- points System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfRedactionPoint}
- label System.String = null
public static PdfRedactionRegion Rectangle(Int32 pageNumber, Double x, Double y, Double width, Double height, String label = null) #PdfRedactionRegionCreates one rectangle region.
Parameters
- pageNumber System.Int32
- x System.Double
- y System.Double
- width System.Double
- height System.Double
- label System.String = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public PdfRedactionRegionKind Kind { get; } #Original review geometry kind.
public Int32 PageNumber { get; } #One-based page number.
public IReadOnlyList<PdfRedactionPoint> Points { get; } #Original points, when the region is path based.
public IReadOnlyList<PdfRedactionArea> Areas { get; } #Canonical bounded destructive areas. Non-rectangular areas retain exact internal geometry.
public String Label { get; } #Optional caller label.
public Double StrokeWidth { get; } #Freehand stroke width in PDF points, or zero for other kinds.