Image Property

Summary

The raster image representation of the page.

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

An RasterImage that contains the image representation of the page.

Remarks

The Image property must contain a RasterImage object --it cannot be null. This image object is used in the DocumentWriter.AddPage or DocumentWriter.InsertPage methods to create the visual representation of the new page added to the document being created.

The LEADTOOLS Document Writer toolkit will not use the RasterImage object after the call to DocumentWriter.AddPage or DocumentWriter.InsertPage returns. This handle needs to be disposed to free the resources associated with it by the user.

The raster image objects can be obtained from multiple sources as explained in LEADTOOLS Document Writers.

The LEADTOOLS Document Writer supports creating documents with zero or more empty pages inside them. Simply pass a page of type DocumentWriterEmptyPage to DocumentWriter.AddPage or DocumentWriter.InsertPage methods. The dimension of the empty page must be set before hand in the DocumentOptions.EmptyPageWidth and DocumentOptions.EmptyPageHeight and its resolution set to DocumentOptions.EmptyPageResolution. As many empty pages as desired can be added and in any index desired. To use empty pages, make sure the DocumentOptions.PageRestriction property is set to DocumentPageRestriction.Relaxed.

Example

For an example, refer to DocumentWriterRasterPage.

Requirements

Target Platforms