Represents a background image.

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


System.Object
   ceTe.DynamicPDF.PageElement
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" );
    }
}

Requirements

Namespace: ceTe.DynamicPDF.PageElements Namespace

Assembly: DynamicPDF.Generator.[Edition].dll

See Also

BackgroundImage members | ceTe.DynamicPDF.PageElements Namespace