BackgroundImage

Namespace:

ceTe.DynamicPDF.PageElements

Assemblies:

DynamicPDF.CoreSuite.dll

Represents a background image.

public class BackgroundImage : TaggablePageElement, ISerializable

Public Class BackgroundImage
    Inherits TaggablePageElement
    Implements ISerializable

Inheritance: ObjectPageElementTaggablePageElementBackgroundImage

Implements: ISerializable

Licensing Info

This class is a full DynamicPDF Core Suite feature. One of the following is required for non-evaluation usage:

• An active DynamicPDF Ultimate Subscription
• An active DynamicPDF Professional or Professional Plus Subscription with DynamicPDF Core Suite selected.
• A DynamicPDF Core Suite for .NET v12.X Developer License.

Examples

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

using System;
using ceTe.DynamicPDF;
using ceTe.DynamicPDF.PageElements;

public class Example
{
    public static void CreatePDF(string outputPath, string imagePath)
    {
        // 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(imagePath);

        // 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(outputPath);
    }
}

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.

Constructors

Properties

Methods

See Also