The Image Property is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.
The image used for creating a PDF document page with the image and text overlay feature.
Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Property Image As RasterImage | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim instance As DocumentPage Dim value As RasterImage instance.Image = value value = instance.Image | |
| C# | |
|---|---|
public RasterImage Image {get; set;} | |
| C++/CLI | |
|---|---|
public: property RasterImage^ Image { RasterImage^ get(); void set ( RasterImage^ value); } | |
Property Value
A Leadtools.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 Visual Basic).Example
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 DocumentPage.EmfHandle property must point to the EMF representation of the page and the DocumentPage.Image must contain a Leadtools.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 PdfDocumentOptions.DocumentType is PdfDocumentType.PdfA.
For more information, refer to PdfDocumentOptions.
You are responsible for freeing this Image object after the call to DocumentWriter.AddPage returns. This is usually done by calling RasterImage.Dispose.
Requirements
Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7