Get Started

API Reference

Class

PdfDocumentReader

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:11
Modifiers sealed

Fluent active-action readback operations for a PdfDocument.

Inheritance

  • Object
  • PdfDocumentReader

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

Methods

public IReadOnlyList<PdfAnnotation> Annotations(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:418
Returns: IReadOnlyList<PdfAnnotation>

Reads generic page annotations in document order.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<PdfAnnotation> AnnotationsByActionType(String actionType, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:446
Returns: IReadOnlyList<PdfAnnotation>

Reads generic page annotations with a matching primary or additional action type.

Parameters

actionType System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfAnnotation> AnnotationsBySubtype(String subtype, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:432
Returns: IReadOnlyList<PdfAnnotation>

Reads generic page annotations with a matching PDF annotation subtype name.

Parameters

subtype System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfAttachmentInfo> AttachmentMetadata(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:123
Returns: IReadOnlyList<PdfAttachmentInfo>

Reads attachment metadata without extracting attachment payload bytes.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<PdfAttachmentInfo> AttachmentMetadataByFileName(String fileName, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:151
Returns: IReadOnlyList<PdfAttachmentInfo>

Reads attachment metadata with a matching file specification file name.

Parameters

fileName System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfAttachmentInfo> AttachmentMetadataByName(String name, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:137
Returns: IReadOnlyList<PdfAttachmentInfo>

Reads attachment metadata with a matching name-tree key or associated-file fallback name.

Parameters

name System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfAttachmentInfo> AttachmentMetadataByRelationship(PdfAssociatedFileRelationship relationship, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:179
Returns: IReadOnlyList<PdfAttachmentInfo>

Reads attachment metadata with a matching associated-file relationship.

Parameters

relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfAttachmentInfo> AttachmentMetadataBySource(String source, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:165
Returns: IReadOnlyList<PdfAttachmentInfo>

Reads attachment metadata from a matching catalog source.

Parameters

source System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfExtractedAttachment> Attachments(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:677
Returns: IReadOnlyList<PdfExtractedAttachment>

Extracts embedded-file attachments.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<PdfCatalogAction> CatalogActions(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:11
Returns: IReadOnlyList<PdfCatalogAction>

Reads catalog-level actions discovered from supported catalog slots and name trees.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<PdfCatalogAction> CatalogActionsByActionType(String actionType, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:25
Returns: IReadOnlyList<PdfCatalogAction>

Reads catalog-level actions with a matching PDF action type.

Parameters

actionType System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfCatalogAction> CatalogActionsBySource(String source, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:39
Returns: IReadOnlyList<PdfCatalogAction>

Reads catalog-level actions from a matching catalog source.

Parameters

source System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public String CatalogLanguage(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:327
Returns: String

Reads the catalog language tag, for example en-US or pl-PL, when present.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public String CatalogPageLayout(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:313
Returns: String

Reads the catalog page layout name, for example SinglePage or TwoColumnLeft, when present.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public String CatalogPageMode(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:306
Returns: String

Reads the catalog page mode name, for example UseOutlines or FullScreen, when present.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public String CatalogVersion(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:320
Returns: String

Reads the catalog PDF version override, for example 1.7, when present.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfDocumentInfo DocumentInfo(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Inspection.cs:11
Returns: PdfDocumentInfo

Reads document-level inspection information through the shared inspector model.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public String EffectiveVersion(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Inspection.cs:92
Returns: String

Reads the effective PDF version inferred from catalog override or file header version.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<OfficeImageExportResult> ExportImages(OfficeImageExportFormat format, PdfImageExportOptions options = null, PdfPageSelection selection = null, PdfReadOptions readOptions = null, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Rendering.cs:16
Returns: IReadOnlyList<OfficeImageExportResult>

Exports all pages or a caller-ordered selection through the shared image-export contract.

Parameters

format OfficeIMO.Drawing.OfficeImageExportFormat requiredposition: 0
options OfficeIMO.Pdf.PdfImageExportOptions = null optionalposition: 1
selection OfficeIMO.Pdf.PdfPageSelection = null optionalposition: 2
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 3
cancellationToken System.Threading.CancellationToken = null optionalposition: 4
ExportStructured 2 overloads
public String ExportStructured(PdfStructuredExportFormat format, PdfTextLayoutOptions layoutOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Interactions.cs:34
Returns: String

Exports the first-party logical model to JSON, Markdown, ALTO XML, hOCR, or PAGE XML.

Parameters

format OfficeIMO.Pdf.PdfStructuredExportFormat requiredposition: 0
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
public String ExportStructured(PdfStructuredExportFormat format, PdfTextLayoutOptions layoutOptions, PdfReadOptions readOptions) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Interactions.cs:41
Returns: String

Exports the first-party logical model with explicit read limits or credentials.

Parameters

format OfficeIMO.Pdf.PdfStructuredExportFormat requiredposition: 0
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions requiredposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions requiredposition: 2
public PdfFormField FormField(String fieldName, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:474
Returns: PdfFormField

Returns the simple AcroForm field with the requested fully qualified field name, when present.

Parameters

fieldName System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
FormFields 4 overloads
public IReadOnlyList<PdfFormField> FormFields(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:460
Returns: IReadOnlyList<PdfFormField>

Extracts simple AcroForm fields from the logical readback model.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<PdfFormField> FormFields(String fieldName, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:484
Returns: IReadOnlyList<PdfFormField>

Extracts simple AcroForm fields matching the requested fully qualified field name.

Parameters

fieldName System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfFormField> FormFields(PdfFormFieldKind kind, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:501
Returns: IReadOnlyList<PdfFormField>

Extracts simple AcroForm fields for the requested common field kind.

Parameters

kind OfficeIMO.Pdf.PdfFormFieldKind requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfFormField> FormFields(Int32 pageNumber, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:515
Returns: IReadOnlyList<PdfFormField>

Extracts simple AcroForm fields represented by widgets on a one-based page number.

Parameters

pageNumber System.Int32 requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
FormWidgets 3 overloads
public IReadOnlyList<PdfLogicalFormWidget> FormWidgets(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:529
Returns: IReadOnlyList<PdfLogicalFormWidget>

Extracts AcroForm widget annotations with page geometry from the logical readback model.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<PdfLogicalFormWidget> FormWidgets(String fieldName, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:543
Returns: IReadOnlyList<PdfLogicalFormWidget>

Extracts AcroForm widget annotations for the requested fully qualified field name.

Parameters

fieldName System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfLogicalFormWidget> FormWidgets(Int32 pageNumber, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:557
Returns: IReadOnlyList<PdfLogicalFormWidget>

Extracts AcroForm widget annotations from a one-based page number.

Parameters

pageNumber System.Int32 requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public String HeaderVersion(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Inspection.cs:85
Returns: String

Reads the PDF header version, for example 1.7, when present.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
ImagePlacements 4 overloads
public IReadOnlyList<PdfImagePlacement> ImagePlacements(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:633
Returns: IReadOnlyList<PdfImagePlacement>

Extracts image XObject placement invocations with page geometry.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<PdfImagePlacement> ImagePlacements(PdfPageSelection selection, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:647
Returns: IReadOnlyList<PdfImagePlacement>

Extracts image XObject placement invocations from selected pages in caller order.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfImagePlacement> ImagePlacements(String pageRanges, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:663
Returns: IReadOnlyList<PdfImagePlacement>

Extracts image XObject placement invocations from pages described by comma- or semicolon-separated inclusive page ranges.

Parameters

pageRanges System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfImagePlacement> ImagePlacements(PdfPageSelector selector, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:68
Returns: IReadOnlyList<PdfImagePlacement>

Extracts image placements from pages resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
Images 4 overloads
public IReadOnlyList<PdfExtractedImage> Images(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:571
Returns: IReadOnlyList<PdfExtractedImage>

Extracts image XObjects.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<PdfExtractedImage> Images(PdfPageSelection selection, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:585
Returns: IReadOnlyList<PdfExtractedImage>

Extracts image XObjects from selected pages in caller order.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfExtractedImage> Images(String pageRanges, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:601
Returns: IReadOnlyList<PdfExtractedImage>

Extracts image XObjects from pages described by comma- or semicolon-separated inclusive page ranges.

Parameters

pageRanges System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfExtractedImage> Images(PdfPageSelector selector, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:58
Returns: IReadOnlyList<PdfExtractedImage>

Extracts images from pages resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfPageInteractionMap Interactions(Int32 pageNumber, PdfPageInteractionOptions interactionOptions = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Interactions.cs:9
Returns: PdfPageInteractionMap

Builds text-selection and interactive hit regions for one page in visual top-left coordinates.

Parameters

pageNumber System.Int32 requiredposition: 0
interactionOptions OfficeIMO.Pdf.PdfPageInteractionOptions = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
public Boolean IsPdf20OrLater(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Inspection.cs:99
Returns: Boolean

Returns true when the effective PDF version is PDF 2.0 or later.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public OfficeDrawing LayoutDebugOverlay(Int32 pageNumber, PdfLayoutDebugOverlayOptions overlayOptions = null, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Interactions.cs:22
Returns: OfficeDrawing

Creates a shared-Drawing word, line, region, and reading-order diagnostic overlay.

Parameters

pageNumber System.Int32 requiredposition: 0
overlayOptions OfficeIMO.Pdf.PdfLayoutDebugOverlayOptions = null optionalposition: 1
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 2
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 3
public IReadOnlyList<PdfLogicalLinkAnnotation> LinksByDestinationName(String destinationName, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:362
Returns: IReadOnlyList<PdfLogicalLinkAnnotation>

Extracts logical internal link annotations for a named destination.

Parameters

destinationName System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfLogicalLinkAnnotation> LinksByDestinationPageNumber(Int32 pageNumber, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:376
Returns: IReadOnlyList<PdfLogicalLinkAnnotation>

Extracts logical internal direct-destination link annotations for a one-based destination page number.

Parameters

pageNumber System.Int32 requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfLogicalLinkAnnotation> LinksByNamedAction(String namedAction, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:390
Returns: IReadOnlyList<PdfLogicalLinkAnnotation>

Extracts logical named-action link annotations for a viewer action name.

Parameters

namedAction System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfLogicalLinkAnnotation> LinksByRemoteFile(String remoteFile, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:404
Returns: IReadOnlyList<PdfLogicalLinkAnnotation>

Extracts logical remote GoTo link annotations for a target file.

Parameters

remoteFile System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfLogicalLinkAnnotation> LinksByUri(String uri, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:348
Returns: IReadOnlyList<PdfLogicalLinkAnnotation>

Extracts logical URI link annotations for a URI action target.

Parameters

uri System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
Logical 4 overloads
public PdfLogicalDocument Logical(PdfTextLayoutOptions options = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:162
Returns: PdfLogicalDocument

Builds the logical document model.

Parameters

options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfLogicalDocument Logical(PdfPageSelection selection, PdfTextLayoutOptions options = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:176
Returns: PdfLogicalDocument

Builds the logical document model for selected pages.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
public PdfLogicalDocument Logical(String pageRanges, PdfTextLayoutOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:192
Returns: PdfLogicalDocument

Builds the logical document model for selected pages.

Parameters

pageRanges System.String requiredposition: 0
options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
public PdfLogicalDocument Logical(PdfPageSelector selector, PdfTextLayoutOptions options = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:38
Returns: PdfLogicalDocument

Builds the logical model for pages resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
Markdown 4 overloads
public String Markdown(PdfTextLayoutOptions options = null, PdfLogicalMarkdownOptions markdownOptions = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:116
Returns: String

Extracts Markdown from the logical readback model.

Parameters

options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 0
markdownOptions OfficeIMO.Pdf.PdfLogicalMarkdownOptions = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
public String Markdown(PdfPageSelection selection, PdfTextLayoutOptions options = null, PdfLogicalMarkdownOptions markdownOptions = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:130
Returns: String

Extracts Markdown from selected pages in the logical readback model.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
markdownOptions OfficeIMO.Pdf.PdfLogicalMarkdownOptions = null optionalposition: 2
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 3
public String Markdown(String pageRanges, PdfTextLayoutOptions options = null, PdfLogicalMarkdownOptions markdownOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:148
Returns: String

Extracts Markdown from selected pages in the logical readback model.

Parameters

pageRanges System.String requiredposition: 0
options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
markdownOptions OfficeIMO.Pdf.PdfLogicalMarkdownOptions = null optionalposition: 2
public String Markdown(PdfPageSelector selector, PdfTextLayoutOptions options = null, PdfLogicalMarkdownOptions markdownOptions = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:28
Returns: String

Extracts Markdown from pages resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
markdownOptions OfficeIMO.Pdf.PdfLogicalMarkdownOptions = null optionalposition: 2
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 3
public PdfMetadata Metadata(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Inspection.cs:25
Returns: PdfMetadata

Reads PDF document metadata from the Info dictionary.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<PdfNamedDestination> NamedDestinations(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:278
Returns: IReadOnlyList<PdfNamedDestination>

Reads named destinations discovered from the document catalog.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public Task<PdfOcrMergeResult> OcrAsync(IPdfOcrProvider provider, PdfOcrMergeOptions options = null, PdfReadOptions readOptions = null, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Ocr.cs:13
Returns: Task<PdfOcrMergeResult>

Runs external OCR through the engine-owned render and native-text merge contract.

Parameters

provider OfficeIMO.Pdf.IPdfOcrProvider requiredposition: 0
options OfficeIMO.Pdf.PdfOcrMergeOptions = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public PdfDocumentOpenAction OpenAction(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:292
Returns: PdfDocumentOpenAction

Reads a simple document open action from the document catalog, when supported.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOptionalContentProperties OptionalContent(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:81
Returns: PdfOptionalContentProperties

Reads optional-content/layer metadata when it is present.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<PdfOptionalContentGroup> OptionalContentGroups(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:95
Returns: IReadOnlyList<PdfOptionalContentGroup>

Reads optional-content groups discovered from catalog /OCProperties.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<PdfOptionalContentGroup> OptionalContentGroupsByName(String name, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:109
Returns: IReadOnlyList<PdfOptionalContentGroup>

Reads optional-content groups with a matching layer display name.

Parameters

name System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfOutlineItem> Outlines(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:250
Returns: IReadOnlyList<PdfOutlineItem>

Reads top-level document outline/bookmark entries from the logical model.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<PdfOutputIntentInfo> OutputIntents(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:25
Returns: IReadOnlyList<PdfOutputIntentInfo>

Reads catalog output-intent metadata.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<PdfOutputIntentInfo> OutputIntentsByOutputConditionIdentifier(String outputConditionIdentifier, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:53
Returns: IReadOnlyList<PdfOutputIntentInfo>

Reads output intents with a matching /OutputConditionIdentifier.

Parameters

outputConditionIdentifier System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfOutputIntentInfo> OutputIntentsBySubtype(String subtype, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:39
Returns: IReadOnlyList<PdfOutputIntentInfo>

Reads output intents with a matching /S subtype.

Parameters

subtype System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfPageInfo Page(Int32 pageNumber, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Inspection.cs:67
Returns: PdfPageInfo

Reads page geometry and page-level metadata for a one-based page number, or null when the page does not exist.

Parameters

pageNumber System.Int32 requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
PageActions 2 overloads
public IReadOnlyList<PdfPageAction> PageActions(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:53
Returns: IReadOnlyList<PdfPageAction>

Reads page-level additional actions discovered from page dictionaries.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<PdfPageAction> PageActions(Int32 pageNumber, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:67
Returns: IReadOnlyList<PdfPageAction>

Reads page-level additional actions for a one-based page number.

Parameters

pageNumber System.Int32 requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfPageAction> PageActionsByActionPath(String actionPath, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:109
Returns: IReadOnlyList<PdfPageAction>

Reads page-level additional actions with a matching stable action path.

Parameters

actionPath System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfPageAction> PageActionsByActionType(String actionType, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:81
Returns: IReadOnlyList<PdfPageAction>

Reads page-level additional actions with a matching PDF action type.

Parameters

actionType System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfPageAction> PageActionsByTriggerName(String triggerName, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:95
Returns: IReadOnlyList<PdfPageAction>

Reads page-level additional actions with a matching page /AA trigger key.

Parameters

triggerName System.String requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfPageLabel> PageLabels(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:264
Returns: IReadOnlyList<PdfPageLabel>

Reads page-label rules discovered from the document catalog.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public IReadOnlyList<PdfPageInfo> Pages(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Inspection.cs:53
Returns: IReadOnlyList<PdfPageInfo>

Reads page geometry and page-level metadata for all pages.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfRawDocumentView RawStructure(PdfRawStructureOptions structureOptions = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.RawStructure.cs:6
Returns: PdfRawDocumentView

Builds a safe, immutable, bounded projection of the active raw object graph.

Parameters

structureOptions OfficeIMO.Pdf.PdfRawStructureOptions = null optionalposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
RenderPages 3 overloads
public IReadOnlyList<PdfPageRenderResult> RenderPages(PdfPageSelection selection = null, PdfPageRenderOptions options = null, PdfReadOptions readOptions = null, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Rendering.cs:25
Returns: IReadOnlyList<PdfPageRenderResult>

Renders all pages or a caller-ordered selection through the managed batch renderer.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection = null optionalposition: 0
options OfficeIMO.Pdf.PdfPageRenderOptions = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public IReadOnlyList<PdfPageRenderResult> RenderPages(String pageRanges, PdfPageRenderOptions options = null, PdfReadOptions readOptions = null, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Rendering.cs:34
Returns: IReadOnlyList<PdfPageRenderResult>

Renders parsed page ranges such as 1-3,5 through the managed batch renderer.

Parameters

pageRanges System.String requiredposition: 0
options OfficeIMO.Pdf.PdfPageRenderOptions = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public IReadOnlyList<PdfPageRenderResult> RenderPages(PdfPageSelector selector, PdfPageRenderOptions options = null, PdfReadOptions readOptions = null, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:82
Returns: IReadOnlyList<PdfPageRenderResult>

Renders pages resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
options OfficeIMO.Pdf.PdfPageRenderOptions = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
SaveImages 2 overloads
public IReadOnlyList<String> SaveImages(String outputDirectory, String baseName = "image", PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:609
Returns: IReadOnlyList<String>

Extracts all readable image XObjects to deterministic files.

Parameters

outputDirectory System.String requiredposition: 0
baseName System.String = "image" optionalposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
public IReadOnlyList<String> SaveImages(String outputDirectory, PdfPageSelection selection, String baseName = "image", PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:618
Returns: IReadOnlyList<String>

Extracts image XObjects from selected pages to deterministic files.

Parameters

outputDirectory System.String requiredposition: 0
selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 1
baseName System.String = "image" optionalposition: 2
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 3
public PdfDocumentSecurityInfo Security(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Inspection.cs:39
Returns: PdfDocumentSecurityInfo

Reads security, signature, and revision markers.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfTaggedContentInfo TaggedContent(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:67
Returns: PdfTaggedContentInfo

Reads tagged PDF structure metadata when it is present.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
Text 4 overloads
public String Text(PdfTextLayoutOptions options = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:24
Returns: String

Extracts plain text from all pages.

Parameters

options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public String Text(PdfPageSelection selection, PdfTextLayoutOptions options = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:39
Returns: String

Extracts plain text from selected pages and concatenates them with blank lines.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
public String Text(String pageRanges, PdfTextLayoutOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:55
Returns: String

Extracts plain text from selected pages and concatenates them with blank lines.

Parameters

pageRanges System.String requiredposition: 0
options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
public String Text(PdfPageSelector selector, PdfTextLayoutOptions options = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:8
Returns: String

Extracts plain text from pages resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
TextBlocks 4 overloads
public IReadOnlyList<PdfLogicalTextBlock> TextBlocks(PdfTextLayoutOptions options = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:206
Returns: IReadOnlyList<PdfLogicalTextBlock>

Extracts line-level logical text blocks from all pages.

Parameters

options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<PdfLogicalTextBlock> TextBlocks(PdfPageSelection selection, PdfTextLayoutOptions options = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:220
Returns: IReadOnlyList<PdfLogicalTextBlock>

Extracts line-level logical text blocks from selected pages.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
public IReadOnlyList<PdfLogicalTextBlock> TextBlocks(String pageRanges, PdfTextLayoutOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:236
Returns: IReadOnlyList<PdfLogicalTextBlock>

Extracts line-level logical text blocks from selected pages.

Parameters

pageRanges System.String requiredposition: 0
options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
public IReadOnlyList<PdfLogicalTextBlock> TextBlocks(PdfPageSelector selector, PdfTextLayoutOptions options = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:48
Returns: IReadOnlyList<PdfLogicalTextBlock>

Extracts logical text blocks from pages resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
TextByPage 4 overloads
public IReadOnlyList<String> TextByPage(PdfTextLayoutOptions options = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:69
Returns: IReadOnlyList<String>

Extracts plain text for each page.

Parameters

options OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<String> TextByPage(PdfPageSelection selection, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:86
Returns: IReadOnlyList<String>

Extracts plain text for selected pages in caller order.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public IReadOnlyList<String> TextByPage(String pageRanges) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:102
Returns: IReadOnlyList<String>

Extracts plain text for selected pages in caller order.

Parameters

pageRanges System.String requiredposition: 0
public IReadOnlyList<String> TextByPage(PdfPageSelector selector, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:18
Returns: IReadOnlyList<String>

Extracts text per page in the order resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfAnnotation>> TryAnnotations(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:425
Returns: PdfOperationResult<IReadOnlyList<PdfAnnotation>>

Attempts to read generic page annotations, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfAnnotation>> TryAnnotationsByActionType(String actionType, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:453
Returns: PdfOperationResult<IReadOnlyList<PdfAnnotation>>

Attempts to read generic page annotations with a matching primary or additional action type, returning diagnostics when blocked or failed.

Parameters

actionType System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfAnnotation>> TryAnnotationsBySubtype(String subtype, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:439
Returns: PdfOperationResult<IReadOnlyList<PdfAnnotation>>

Attempts to read generic page annotations with a matching PDF annotation subtype name, returning diagnostics when blocked or failed.

Parameters

subtype System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfAttachmentInfo>> TryAttachmentMetadata(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:130
Returns: PdfOperationResult<IReadOnlyList<PdfAttachmentInfo>>

Attempts to read attachment metadata without extracting attachment payload bytes, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfAttachmentInfo>> TryAttachmentMetadataByFileName(String fileName, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:158
Returns: PdfOperationResult<IReadOnlyList<PdfAttachmentInfo>>

Attempts to read attachment metadata with a matching file specification file name.

Parameters

fileName System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfAttachmentInfo>> TryAttachmentMetadataByName(String name, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:144
Returns: PdfOperationResult<IReadOnlyList<PdfAttachmentInfo>>

Attempts to read attachment metadata with a matching name-tree key or associated-file fallback name.

Parameters

name System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfAttachmentInfo>> TryAttachmentMetadataByRelationship(PdfAssociatedFileRelationship relationship, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:186
Returns: PdfOperationResult<IReadOnlyList<PdfAttachmentInfo>>

Attempts to read attachment metadata with a matching associated-file relationship.

Parameters

relationship OfficeIMO.Pdf.PdfAssociatedFileRelationship requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfAttachmentInfo>> TryAttachmentMetadataBySource(String source, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:172
Returns: PdfOperationResult<IReadOnlyList<PdfAttachmentInfo>>

Attempts to read attachment metadata from a matching catalog source.

Parameters

source System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfExtractedAttachment>> TryAttachments(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:684
Returns: PdfOperationResult<IReadOnlyList<PdfExtractedAttachment>>

Attempts to extract embedded-file attachments, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfCatalogAction>> TryCatalogActions(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:18
Returns: PdfOperationResult<IReadOnlyList<PdfCatalogAction>>

Attempts to read catalog-level actions, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfCatalogAction>> TryCatalogActionsByActionType(String actionType, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:32
Returns: PdfOperationResult<IReadOnlyList<PdfCatalogAction>>

Attempts to read catalog-level actions with a matching PDF action type, returning diagnostics when blocked or failed.

Parameters

actionType System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfCatalogAction>> TryCatalogActionsBySource(String source, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:46
Returns: PdfOperationResult<IReadOnlyList<PdfCatalogAction>>

Attempts to read catalog-level actions from a matching catalog source, returning diagnostics when blocked or failed.

Parameters

source System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<PdfDocumentInfo> TryDocumentInfo(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Inspection.cs:18
Returns: PdfOperationResult<PdfDocumentInfo>

Attempts to read document-level inspection information, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
TryFormFields 4 overloads
public PdfOperationResult<IReadOnlyList<PdfFormField>> TryFormFields(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:467
Returns: PdfOperationResult<IReadOnlyList<PdfFormField>>

Attempts to extract simple AcroForm fields, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfFormField>> TryFormFields(String fieldName, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:494
Returns: PdfOperationResult<IReadOnlyList<PdfFormField>>

Attempts to extract simple AcroForm fields matching the requested fully qualified field name, returning diagnostics when blocked or failed.

Parameters

fieldName System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfFormField>> TryFormFields(PdfFormFieldKind kind, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:508
Returns: PdfOperationResult<IReadOnlyList<PdfFormField>>

Attempts to extract simple AcroForm fields for the requested common field kind, returning diagnostics when blocked or failed.

Parameters

kind OfficeIMO.Pdf.PdfFormFieldKind requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfFormField>> TryFormFields(Int32 pageNumber, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:522
Returns: PdfOperationResult<IReadOnlyList<PdfFormField>>

Attempts to extract simple AcroForm fields represented by widgets on a one-based page number, returning diagnostics when blocked or failed.

Parameters

pageNumber System.Int32 requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
TryFormWidgets 3 overloads
public PdfOperationResult<IReadOnlyList<PdfLogicalFormWidget>> TryFormWidgets(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:536
Returns: PdfOperationResult<IReadOnlyList<PdfLogicalFormWidget>>

Attempts to extract AcroForm widget annotations with page geometry, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfLogicalFormWidget>> TryFormWidgets(String fieldName, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:550
Returns: PdfOperationResult<IReadOnlyList<PdfLogicalFormWidget>>

Attempts to extract AcroForm widget annotations for the requested fully qualified field name, returning diagnostics when blocked or failed.

Parameters

fieldName System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfLogicalFormWidget>> TryFormWidgets(Int32 pageNumber, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:564
Returns: PdfOperationResult<IReadOnlyList<PdfLogicalFormWidget>>

Attempts to extract AcroForm widget annotations from a one-based page number, returning diagnostics when blocked or failed.

Parameters

pageNumber System.Int32 requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
TryImagePlacements 4 overloads
public PdfOperationResult<IReadOnlyList<PdfImagePlacement>> TryImagePlacements(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:640
Returns: PdfOperationResult<IReadOnlyList<PdfImagePlacement>>

Attempts to extract image XObject placement invocations with page geometry, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfImagePlacement>> TryImagePlacements(PdfPageSelection selection, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:655
Returns: PdfOperationResult<IReadOnlyList<PdfImagePlacement>>

Attempts to extract image XObject placement invocations from selected pages, returning diagnostics when blocked or failed.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfImagePlacement>> TryImagePlacements(String pageRanges, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:670
Returns: PdfOperationResult<IReadOnlyList<PdfImagePlacement>>

Attempts to extract image XObject placement invocations from pages described by page ranges, returning diagnostics when blocked or failed.

Parameters

pageRanges System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfImagePlacement>> TryImagePlacements(PdfPageSelector selector, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:72
Returns: PdfOperationResult<IReadOnlyList<PdfImagePlacement>>

Attempts to extract image placements from pages resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
TryImages 4 overloads
public PdfOperationResult<IReadOnlyList<PdfExtractedImage>> TryImages(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:578
Returns: PdfOperationResult<IReadOnlyList<PdfExtractedImage>>

Attempts to extract image XObjects, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfExtractedImage>> TryImages(PdfPageSelection selection, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:593
Returns: PdfOperationResult<IReadOnlyList<PdfExtractedImage>>

Attempts to extract image XObjects from selected pages, returning diagnostics when blocked or failed.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfExtractedImage>> TryImages(String pageRanges, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:626
Returns: PdfOperationResult<IReadOnlyList<PdfExtractedImage>>

Attempts to extract image XObjects from pages described by page ranges, returning diagnostics when blocked or failed.

Parameters

pageRanges System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfExtractedImage>> TryImages(PdfPageSelector selector, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:62
Returns: PdfOperationResult<IReadOnlyList<PdfExtractedImage>>

Attempts to extract images from pages resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfLogicalLinkAnnotation>> TryLinksByDestinationName(String destinationName, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:369
Returns: PdfOperationResult<IReadOnlyList<PdfLogicalLinkAnnotation>>

Attempts to extract logical internal link annotations for a named destination, returning diagnostics when blocked or failed.

Parameters

destinationName System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfLogicalLinkAnnotation>> TryLinksByDestinationPageNumber(Int32 pageNumber, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:383
Returns: PdfOperationResult<IReadOnlyList<PdfLogicalLinkAnnotation>>

Attempts to extract logical internal direct-destination link annotations for a one-based destination page number, returning diagnostics when blocked or failed.

Parameters

pageNumber System.Int32 requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfLogicalLinkAnnotation>> TryLinksByNamedAction(String namedAction, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:397
Returns: PdfOperationResult<IReadOnlyList<PdfLogicalLinkAnnotation>>

Attempts to extract logical named-action link annotations for a viewer action name, returning diagnostics when blocked or failed.

Parameters

namedAction System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfLogicalLinkAnnotation>> TryLinksByRemoteFile(String remoteFile, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:411
Returns: PdfOperationResult<IReadOnlyList<PdfLogicalLinkAnnotation>>

Attempts to extract logical remote GoTo link annotations for a target file, returning diagnostics when blocked or failed.

Parameters

remoteFile System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfLogicalLinkAnnotation>> TryLinksByUri(String uri, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:355
Returns: PdfOperationResult<IReadOnlyList<PdfLogicalLinkAnnotation>>

Attempts to extract logical URI link annotations for a URI action target, returning diagnostics when blocked or failed.

Parameters

uri System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
TryLogical 4 overloads
public PdfOperationResult<PdfLogicalDocument> TryLogical(PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:169
Returns: PdfOperationResult<PdfLogicalDocument>

Attempts to build the logical document model, returning diagnostics when blocked or failed.

Parameters

layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<PdfLogicalDocument> TryLogical(PdfPageSelection selection, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:184
Returns: PdfOperationResult<PdfLogicalDocument>

Attempts to build the logical document model for selected pages, returning diagnostics when blocked or failed.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
public PdfOperationResult<PdfLogicalDocument> TryLogical(String pageRanges, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:199
Returns: PdfOperationResult<PdfLogicalDocument>

Attempts to build the logical document model for selected pages described by page ranges, returning diagnostics when blocked or failed.

Parameters

pageRanges System.String requiredposition: 0
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
public PdfOperationResult<PdfLogicalDocument> TryLogical(PdfPageSelector selector, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:42
Returns: PdfOperationResult<PdfLogicalDocument>

Attempts to build the logical model for pages resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
TryMarkdown 4 overloads
public PdfOperationResult<String> TryMarkdown(PdfTextLayoutOptions layoutOptions = null, PdfLogicalMarkdownOptions markdownOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:123
Returns: PdfOperationResult<String>

Attempts to extract Markdown from the logical readback model, returning diagnostics when blocked or failed.

Parameters

layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 0
markdownOptions OfficeIMO.Pdf.PdfLogicalMarkdownOptions = null optionalposition: 1
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
public PdfOperationResult<String> TryMarkdown(PdfPageSelection selection, PdfTextLayoutOptions layoutOptions = null, PdfLogicalMarkdownOptions markdownOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:140
Returns: PdfOperationResult<String>

Attempts to extract Markdown from selected pages, returning diagnostics when blocked or failed.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
markdownOptions OfficeIMO.Pdf.PdfLogicalMarkdownOptions = null optionalposition: 2
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 3
public PdfOperationResult<String> TryMarkdown(String pageRanges, PdfTextLayoutOptions layoutOptions = null, PdfLogicalMarkdownOptions markdownOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:155
Returns: PdfOperationResult<String>

Attempts to extract Markdown from selected pages described by page ranges, returning diagnostics when blocked or failed.

Parameters

pageRanges System.String requiredposition: 0
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
markdownOptions OfficeIMO.Pdf.PdfLogicalMarkdownOptions = null optionalposition: 2
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 3
public PdfOperationResult<String> TryMarkdown(PdfPageSelector selector, PdfTextLayoutOptions layoutOptions = null, PdfLogicalMarkdownOptions markdownOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:32
Returns: PdfOperationResult<String>

Attempts to extract Markdown from pages resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
markdownOptions OfficeIMO.Pdf.PdfLogicalMarkdownOptions = null optionalposition: 2
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 3
public PdfOperationResult<PdfMetadata> TryMetadata(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Inspection.cs:32
Returns: PdfOperationResult<PdfMetadata>

Attempts to read PDF document metadata, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfNamedDestination>> TryNamedDestinations(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:285
Returns: PdfOperationResult<IReadOnlyList<PdfNamedDestination>>

Attempts to read named destinations, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<PdfOptionalContentProperties> TryOptionalContent(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:88
Returns: PdfOperationResult<PdfOptionalContentProperties>

Attempts to read optional-content/layer metadata, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfOptionalContentGroup>> TryOptionalContentGroups(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:102
Returns: PdfOperationResult<IReadOnlyList<PdfOptionalContentGroup>>

Attempts to read optional-content groups, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfOptionalContentGroup>> TryOptionalContentGroupsByName(String name, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:116
Returns: PdfOperationResult<IReadOnlyList<PdfOptionalContentGroup>>

Attempts to read optional-content groups with a matching layer display name, returning diagnostics when blocked or failed.

Parameters

name System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfOutlineItem>> TryOutlines(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:257
Returns: PdfOperationResult<IReadOnlyList<PdfOutlineItem>>

Attempts to read top-level document outline/bookmark entries, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfOutputIntentInfo>> TryOutputIntents(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:32
Returns: PdfOperationResult<IReadOnlyList<PdfOutputIntentInfo>>

Attempts to read catalog output-intent metadata, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfOutputIntentInfo>> TryOutputIntentsByOutputConditionIdentifier(String outputConditionIdentifier, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:60
Returns: PdfOperationResult<IReadOnlyList<PdfOutputIntentInfo>>

Attempts to read output intents with a matching /OutputConditionIdentifier, returning diagnostics when blocked or failed.

Parameters

outputConditionIdentifier System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfOutputIntentInfo>> TryOutputIntentsBySubtype(String subtype, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:46
Returns: PdfOperationResult<IReadOnlyList<PdfOutputIntentInfo>>

Attempts to read output intents with a matching /S subtype, returning diagnostics when blocked or failed.

Parameters

subtype System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
TryPageActions 2 overloads
public PdfOperationResult<IReadOnlyList<PdfPageAction>> TryPageActions(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:60
Returns: PdfOperationResult<IReadOnlyList<PdfPageAction>>

Attempts to read page-level additional actions, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfPageAction>> TryPageActions(Int32 pageNumber, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:74
Returns: PdfOperationResult<IReadOnlyList<PdfPageAction>>

Attempts to read page-level additional actions for a one-based page number, returning diagnostics when blocked or failed.

Parameters

pageNumber System.Int32 requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfPageAction>> TryPageActionsByActionPath(String actionPath, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:116
Returns: PdfOperationResult<IReadOnlyList<PdfPageAction>>

Attempts to read page-level additional actions with a matching stable action path, returning diagnostics when blocked or failed.

Parameters

actionPath System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfPageAction>> TryPageActionsByActionType(String actionType, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:88
Returns: PdfOperationResult<IReadOnlyList<PdfPageAction>>

Attempts to read page-level additional actions with a matching PDF action type, returning diagnostics when blocked or failed.

Parameters

actionType System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfPageAction>> TryPageActionsByTriggerName(String triggerName, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Actions.cs:102
Returns: PdfOperationResult<IReadOnlyList<PdfPageAction>>

Attempts to read page-level additional actions with a matching page /AA trigger key, returning diagnostics when blocked or failed.

Parameters

triggerName System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfPageLabel>> TryPageLabels(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:271
Returns: PdfOperationResult<IReadOnlyList<PdfPageLabel>>

Attempts to read page-label rules, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<IReadOnlyList<PdfPageInfo>> TryPages(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Inspection.cs:60
Returns: PdfOperationResult<IReadOnlyList<PdfPageInfo>>

Attempts to read page geometry and page-level metadata for all pages, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<PdfRawDocumentView> TryRawStructure(PdfRawStructureOptions structureOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.RawStructure.cs:11
Returns: PdfOperationResult<PdfRawDocumentView>

Attempts to build a bounded raw object view with preflight diagnostics.

Parameters

structureOptions OfficeIMO.Pdf.PdfRawStructureOptions = null optionalposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<PdfDocumentSecurityInfo> TrySecurity(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Inspection.cs:46
Returns: PdfOperationResult<PdfDocumentSecurityInfo>

Attempts to read security, signature, and revision markers, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfOperationResult<PdfTaggedContentInfo> TryTaggedContent(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:74
Returns: PdfOperationResult<PdfTaggedContentInfo>

Attempts to read tagged PDF structure metadata, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
TryText 4 overloads
public PdfOperationResult<String> TryText(PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:32
Returns: PdfOperationResult<String>

Attempts to extract plain text from all pages, returning diagnostics when blocked or failed.

Parameters

layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<String> TryText(PdfPageSelection selection, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:47
Returns: PdfOperationResult<String>

Attempts to extract plain text from selected pages, returning diagnostics when blocked or failed.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
public PdfOperationResult<String> TryText(String pageRanges, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:62
Returns: PdfOperationResult<String>

Attempts to extract plain text from selected pages described by page ranges, returning diagnostics when blocked or failed.

Parameters

pageRanges System.String requiredposition: 0
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
public PdfOperationResult<String> TryText(PdfPageSelector selector, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:12
Returns: PdfOperationResult<String>

Attempts to extract plain text from pages resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
TryTextBlocks 4 overloads
public PdfOperationResult<IReadOnlyList<PdfLogicalTextBlock>> TryTextBlocks(PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:213
Returns: PdfOperationResult<IReadOnlyList<PdfLogicalTextBlock>>

Attempts to extract line-level logical text blocks from all pages, returning diagnostics when blocked or failed.

Parameters

layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<PdfLogicalTextBlock>> TryTextBlocks(PdfPageSelection selection, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:228
Returns: PdfOperationResult<IReadOnlyList<PdfLogicalTextBlock>>

Attempts to extract line-level logical text blocks from selected pages, returning diagnostics when blocked or failed.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
public PdfOperationResult<IReadOnlyList<PdfLogicalTextBlock>> TryTextBlocks(String pageRanges, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:243
Returns: PdfOperationResult<IReadOnlyList<PdfLogicalTextBlock>>

Attempts to extract line-level logical text blocks from selected pages described by page ranges, returning diagnostics when blocked or failed.

Parameters

pageRanges System.String requiredposition: 0
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
public PdfOperationResult<IReadOnlyList<PdfLogicalTextBlock>> TryTextBlocks(PdfPageSelector selector, PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:52
Returns: PdfOperationResult<IReadOnlyList<PdfLogicalTextBlock>>

Attempts to extract logical text blocks from pages resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 1
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
TryTextByPage 4 overloads
public PdfOperationResult<IReadOnlyList<String>> TryTextByPage(PdfTextLayoutOptions layoutOptions = null, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:79
Returns: PdfOperationResult<IReadOnlyList<String>>

Attempts to extract plain text for each page, returning diagnostics when blocked or failed.

Parameters

layoutOptions OfficeIMO.Pdf.PdfTextLayoutOptions = null optionalposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<String>> TryTextByPage(PdfPageSelection selection, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:94
Returns: PdfOperationResult<IReadOnlyList<String>>

Attempts to extract plain text for selected pages in caller order, returning diagnostics when blocked or failed.

Parameters

selection OfficeIMO.Pdf.PdfPageSelection requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<String>> TryTextByPage(String pageRanges, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:109
Returns: PdfOperationResult<IReadOnlyList<String>>

Attempts to extract plain text for selected pages described by page ranges, returning diagnostics when blocked or failed.

Parameters

pageRanges System.String requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<IReadOnlyList<String>> TryTextByPage(PdfPageSelector selector, PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:22
Returns: PdfOperationResult<IReadOnlyList<String>>

Attempts to extract text per page resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 1
public PdfOperationResult<PdfXmpMetadataInfo> TryXmpMetadata(PdfReadOptions options = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:18
Returns: PdfOperationResult<PdfXmpMetadataInfo>

Attempts to read catalog XMP metadata, returning diagnostics when blocked or failed.

Parameters

options OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
Understand 2 overloads
public PdfUnderstandingResult Understand(PdfPageSelector selector, PdfUnderstandingPipelineOptions options = null, PdfReadOptions readOptions = null, CancellationToken cancellationToken = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Selectors.cs:91
Returns: PdfUnderstandingResult

Runs the understanding pipeline for pages resolved by a document-relative selector.

Parameters

selector OfficeIMO.Pdf.PdfPageSelector requiredposition: 0
options OfficeIMO.Pdf.PdfUnderstandingPipelineOptions = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
cancellationToken System.Threading.CancellationToken = null optionalposition: 3
public PdfUnderstandingResult Understand(PdfUnderstandingPipelineOptions options = null, PdfPageSelection selection = null, PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Understanding.cs:6
Returns: PdfUnderstandingResult

Runs the pluggable text-understanding pipeline for all or selected pages.

Parameters

options OfficeIMO.Pdf.PdfUnderstandingPipelineOptions = null optionalposition: 0
selection OfficeIMO.Pdf.PdfPageSelection = null optionalposition: 1
readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 2
public PdfViewerPreferences ViewerPreferences(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.cs:299
Returns: PdfViewerPreferences

Reads simple viewer preference entries from the document catalog, when supported.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0
public PdfXmpMetadataInfo XmpMetadata(PdfReadOptions readOptions = null) #
OfficeIMO.Pdf/Core/PdfDocumentReader.Metadata.cs:11
Returns: PdfXmpMetadataInfo

Reads catalog XMP metadata when a readable metadata stream is present.

Parameters

readOptions OfficeIMO.Pdf.PdfReadOptions = null optionalposition: 0