Represents a background image.

For a list of all members of this type, see BackgroundImage members.

Object Model

Inheritance Hierarchy

System.Object
ceTe.DynamicPDF.PageElement
ceTe.DynamicPDF.PageElements.BackgroundImage

Syntax

[Visual Basic]
Public Class BackgroundImage 
   Inherits PageElement

[C#]
public class BackgroundImage : PageElement

Remarks

This class can be used to place an image on the page that will be stretched to the dimensions of the page. If an image will be used more than once, please see the Image Reuse topic.

Example

The following example will place an image on the page making it the background for that page.

[Visual Basic]

Imports System
Imports ceTe.DynamicPDF
Imports ceTe.DynamicPDF.PageElements

Module MyModule

    Sub Main()
        ' Create a PDF Document
        Dim MyDocument As Document = New Document

        ' Create a Page and add it to the document
        Dim MyPage As Page = New Page
        MyDocument.Pages.Add(MyPage)

        ' Create a background image
        Dim MyBackgroundImage As BackgroundImage = New BackgroundImage("C:\MyImage.jpg")

        ' Place the image with in the page margins
        MyBackgroundImage.UseMargins = True

        ' Add the background image to the page
        MyPage.Elements.Add(MyBackgroundImage)

        ' Save the PDF
        MyDocument.Draw("C:\MyDocument.pdf")

    End Sub
End Module

[C#]

using System; 
using ceTe.DynamicPDF; 
using ceTe.DynamicPDF.PageElements; 
 
class MyClass 
{ 
    static void Main() 
    { 
        // Create a PDF Document 
        Document document = new Document(); 
 
        // Create a page and add it to the document 
        Page page = new Page(); 
        document.Pages.Add( page ); 
 
        // Create a background image 
        BackgroundImage backgroundImage = new BackgroundImage( @"C:\MyImage.jpg" ); 
 
        // Place the image with in the page margins 
        backgroundImage.UseMargins = true; 
     
        // Add the background image to the page 
        page.Elements.Add( backgroundImage );     
 
        //Save the PDF 
        document.Draw( @"C:\MyDocument.pdf" ); 
    } 
}

Licensing

This class is a DynamicPDF Generator Professional Edition feature, except for the use of 64 bit PNG images (in this case see below). One of the following licenses is required for non-evaluation usage:

DynamicPDF Generator Professional Edition
DynamicPDF Generator Enterprise Edition
DynamicPDF Merger Professional Edition
DynamicPDF Merger Enterprise Edition

Use of 64 bit PNG images with this class is an Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:

DynamicPDF Generator Enterprise Edition
DynamicPDF Merger Enterprise Edition

Requirements

Namespace: ceTe.DynamicPDF.PageElements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Assembly: ceTe.DynamicPDF (in ceTe.DynamicPDF.dll)

See Also

Requirements

Language

BackgroundImage Class

Object Model

Inheritance Hierarchy

Syntax

Remarks

Example

Licensing

Requirements

See Also