SetTextExtractionWordGap

Text, Extraction

Version history

This function was introduced in Quick PDF Library version 7.21.

Description

Sets the word gap ratio for the text extraction functionality.

From 8.13, this function sets the text extraction options for the selected document only. It also only affects the results of the GetPageText function.

To adjust the text extraction for the ExtractFilePageText and DAExtractPageText functions, use the new DASetTextExtractionWordGap function.

The word gap ratio is the maximum distance between two text blocks specified as the ratio of the horizontal distance between the blocks to the height of the text.

The default initial value is 0.7 and smaller values will allow closer distances between words.

Syntax

Delphi

function TQuickPDF0813.SetTextExtractionWordGap(NewWordGap: Double): Integer;

ActiveX

Function QuickPDF0813.PDFLibrary::SetTextExtractionWordGap(
  NewWordGap As Double) As Long

DLL

int QuickPDFSetTextExtractionWordGap(int InstanceID, double NewWordGap)

Parameters

NewWordGap

The new WordGap ratio

Return values

1	The word gap ratio was set successfully.