Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 606 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

PdfRedactionRegion

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source revision 804a7612eee4 with working tree changes
Source PdfRedactionRegion.cs:63
Modifiers sealed

Review geometry normalized into bounded areas that retain exact polygon or freehand geometry through planning, destructive application, verification, and evidence.

Inheritance

  • Object
  • PdfRedactionRegion

Usage

Explore 9 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 7

Accepted by parameters 2

Methods

public static PdfRedactionRegion Freehand(Int32 pageNumber, IEnumerable<PdfRedactionPoint> points, Double strokeWidth, String? label = null) #
PdfRedactionRegion.cs:77
Returns: PdfRedactionRegion

Creates an exact round-capped freehand region split into bounded path segments.

Parameters

pageNumber System.Int32 requiredposition: 0
points System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfRedactionPoint> requiredposition: 1
strokeWidth System.Double requiredposition: 2
label System.String? = null optionalposition: 3
public static PdfRedactionRegion FromRedactAnnotation(PdfAnnotation annotation) #
PdfRedactionRegion.cs:107
Returns: PdfRedactionRegion

Creates 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 requiredposition: 0
public static PdfRedactionRegion Group(Int32 pageNumber, IEnumerable<PdfRedactionArea> areas, String? label = null) #
PdfRedactionRegion.cs:97
Returns: PdfRedactionRegion

Groups pre-normalized rectangles from one page into one review decision.

Parameters

pageNumber System.Int32 requiredposition: 0
areas System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfRedactionArea> requiredposition: 1
label System.String? = null optionalposition: 2
public static PdfRedactionRegion Polygon(Int32 pageNumber, IEnumerable<PdfRedactionPoint> points, String? label = null) #
PdfRedactionRegion.cs:73
Returns: PdfRedactionRegion

Creates an exact polygon.

Parameters

pageNumber System.Int32 requiredposition: 0
points System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfRedactionPoint> requiredposition: 1
label System.String? = null optionalposition: 2
public static PdfRedactionRegion Quadrilateral(Int32 pageNumber, IEnumerable<PdfRedactionPoint> points, String? label = null) #
PdfRedactionRegion.cs:69
Returns: PdfRedactionRegion

Creates an exact quadrilateral.

Parameters

pageNumber System.Int32 requiredposition: 0
points System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfRedactionPoint> requiredposition: 1
label System.String? = null optionalposition: 2
public static PdfRedactionRegion Rectangle(Int32 pageNumber, Double x, Double y, Double width, Double height, String? label = null) #
PdfRedactionRegion.cs:63
Returns: PdfRedactionRegion

Creates one rectangle region.

Parameters

pageNumber System.Int32 requiredposition: 0
x System.Double requiredposition: 1
y System.Double requiredposition: 2
width System.Double requiredposition: 3
height System.Double requiredposition: 4
label System.String? = null optionalposition: 5

Properties

public PdfRedactionRegionKind Kind { get; } #
PdfRedactionRegion.cs:49

Original review geometry kind.

public Int32 PageNumber { get; } #
PdfRedactionRegion.cs:51

One-based page number.

public IReadOnlyList<PdfRedactionPoint> Points { get; } #
PdfRedactionRegion.cs:53

Original points, when the region is path based.

public IReadOnlyList<PdfRedactionArea> Areas { get; } #
PdfRedactionRegion.cs:55

Canonical bounded destructive areas. Non-rectangular areas retain exact internal geometry.

public String? Label { get; } #
PdfRedactionRegion.cs:57

Optional caller label.

public Double StrokeWidth { get; } #
PdfRedactionRegion.cs:59

Freehand stroke width in PDF points, or zero for other kinds.