ImageOverText Property

Summary

Indicates whether to use a raster image overlay on top of the resulting PDF document.

Syntax

Objective-C

C++

Java

public bool ImageOverText {get; set;}

Public Property ImageOverText As Boolean

@property (nonatomic, assign) BOOL imageOverText

public boolean getImageOverText()  
public void setImageOverText(boolean imageOverText)

public: 
property bool ImageOverText { 
   bool get(); 
   void set (    bool ); 
}

Property Value

true to use a raster image overlay on top of the resulting PDF document; otherwise, false. The default value is false.

Remarks

PdfDocumentOptions.ImageOverText is used when creating a searchable PDF document that is required to look the same as the original. When true, an image of the original file will be saved over the entire PDF document as an overlay. When using the resulting document in a PDF viewer, you can still search the text underneath the overlay image and still maintain the look of the original document.

The DocumentWriter.AddPage method and the DocumentWriterPage structure provide more information on how to create a PDF file that uses overlay images.

Use the ImageOverTextSize property to control the quality of the overlay image.

Use the ImageOverTextMode property to control if and how grayscale images are treated in the final document.

Use CodecsPdfLoadOptions.DropImageOverText to control whether the overlay image is dropped when loading the PDF page as a raster or an SVG image.

Example

For an example, refer to PdfDocumentOptions.

Requirements

Target Platforms