API Reference
PdfRedactionSearchOptions
Explicit criteria used to derive reviewable redaction rectangles from logical content.
Inheritance
- Object
- PdfRedactionSearchOptions
Usage
Explore 5 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 4
Accepted by parameters 1
- Method PdfDocumentRedactions.Search
Constructors
public PdfRedactionSearchOptions() #Methods
public PdfRedactionSearchOptions AddFormField(params String[] fieldNames) #PdfRedactionSearchOptionsAdds fully qualified AcroForm field names.
Parameters
- fieldNames System.String[]
public PdfRedactionSearchOptions AddLiteral(params String[] values) #PdfRedactionSearchOptionsAdds literal text criteria.
Parameters
- values System.String[]
public PdfRedactionSearchOptions AddLogicalKind(params PdfLogicalElementKind[] kinds) #PdfRedactionSearchOptionsAdds logical element kinds such as Heading, ListItem, or TextBlock.
Parameters
- kinds OfficeIMO.Pdf.PdfLogicalElementKind[]
public PdfRedactionSearchOptions AddRegex(params String[] patterns) #PdfRedactionSearchOptionsAdds bounded regular-expression criteria.
Parameters
- patterns System.String[]
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public CancellationToken CancellationToken { get; set; } #Cooperative cancellation checked while deriving candidates.
public Boolean MatchCase { get; set; } #Case-sensitive literal matching when true.
public PdfRedactionTextSelection TextSelection { get; set; } #Selection granularity for literal and regular-expression criteria. Defaults to complete logical blocks.
public PdfRedactionContentScope ContentScope { get; set; } #Intersecting-content policy applied to generated areas. Defaults to text and underlay removal.
public TimeSpan RegexTimeout { get; set; } #Timeout applied independently to every regular-expression match.
public Int32 MaximumCandidates { get; set; } #Maximum candidate rectangles produced before planning stops fail-closed.
public ISet<Int32> PageNumbers { get; } #One-based pages to search. An empty set searches every page. Candidate limits apply only to these pages.
public RegexOptions RegexOptions { get; set; } #Regular-expression options. CultureInvariant is recommended for reproducible plans.
public IList<String> RegularExpressions { get; } #Regular-expression criteria.
public IList<String> FormFieldNames { get; } #Fully qualified AcroForm field names whose widgets should be selected.
public ISet<PdfLogicalElementKind> LogicalElementKinds { get; } #Logical element kinds whose text blocks should be selected.