[]
        
(Showing Draft Content)

GrapeCity.Documents.Pdf.AI.OpenAIDocumentAssistantBase.BuildOutlines

BuildOutlines Method

BuildOutlines(GcPdfDocument, RecognitionAlgorithm, OutlineNodeCollection, OutputRange, CancellationToken)

Analyzes the specified GcPdfDocument and generates outlines for it.

Declaration
public Task BuildOutlines(GcPdfDocument doc, RecognitionAlgorithm recognitionAlgorithm = RecognitionAlgorithm.AcrobatLike, OutlineNodeCollection outlines = null, OutputRange pageRange = null, CancellationToken cancellationToken = default)
Public Function BuildOutlines(doc As GcPdfDocument, Optional recognitionAlgorithm As RecognitionAlgorithm = RecognitionAlgorithm.AcrobatLike, Optional outlines As OutlineNodeCollection = Nothing, Optional pageRange As OutputRange = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task
Parameters
Type Name Description
GcPdfDocument doc

The GcPdfDocument to analyze.

RecognitionAlgorithm recognitionAlgorithm

The RecognitionAlgorithm to use for analyzing the document. Defaults to AcrobatLike.

OutlineNodeCollection outlines

The OutlineNodeCollection to populate with the generated outlines. If null, the generated outlines will replace the contents of doc's Outlines.

OutputRange pageRange

The range of pages to process. Defaults to null, which means all pages are processed.

CancellationToken cancellationToken

A token that can be used to cancel the operation. Defaults to None.

Returns
Type Description
Task