Image Property

Summary

The image used for creating a PDF document page with the image and text overlay feature.

Syntax

Objective-C

C++

Java

public RasterImage Image { get; set; }

Public Property Image As RasterImage

@property (nonatomic, strong) LTRasterImage *image

public RasterImage getImage() 
public void setImage(RasterImage image)

public: 
property RasterImage^ Image { 
   RasterImage^ get(); 
   void set (    RasterImage^ ); 
}

Property Value

A RasterImage that contains the optional raster image to use to create a PDF page with the image/text overlay feature. If this feature is not used, this property must be set to null (Nothing in VB).

Remarks

The Image property is optional and is used only when the document being created is PDF with the Image and Text overlay option. To create a PDF document with image/text overlay, perform the following steps:

Set the value of the PdfDocumentOptions.ImageOverText to true. You can use the DocumentWriter.GetOptions and DocumentWriter.SetOptions methods to the get the options used when saving a PDF document.
Call DocumentWriter.BeginDocument with DocumentFormat.Pdf as the format to use.
Add the document pages. The DocumentWriterSvgPage.SvgDocument property must point to the SVG representation of the page and the DocumentWriterSvgPage.Image must contain a RasterImage object for the image to be used as the overlay for the page.
Repeat for each page in the document.
Call DocumentWriter.EndDocument to finish creating the document file on disk.

The AnnotationContainer property is optional and is used to create annotated document. It's only valid when the document being created is PDF. Note that saving annotated document is not supported when DocumentType is PdfDocumentType.PdfA.

For more information, refer to PdfDocumentOptions.

You are responsible for freeing this Image object after the call to AddPage or InsertPage returns. This is usually done by calling RasterImage.Dispose.

Example

For an example, refer to DocumentWriter.

Requirements

Target Platforms