This documentation is archived and is not being maintained.

XpsImage Class

Represents an image in an XpsDocument.

Namespace:  System.Windows.Xps.Packaging
Assembly:  ReachFramework (in ReachFramework.dll)

public class XpsImage : XpsResource
You cannot directly create an instance of this class in XAML.

The XpsImage class has no public constructor.

Use the AddImage method to add an image and obtain a reference to it in a new document.

Use the GetImage method to obtain an image reference in an existing document.

Based on settings of XpsSerializationManager and XpsPackagingPolicy, such as FontSubsetterCommitPolicies and PackageInterleavingOrder, the flush operation of the Commit method of the XpsImage class may be delayed until the complete XpsDocument is closed.

The following example shows how to add images to an XpsDocument.

// -------------------------- AddPageResources ---------------------------- 
private Dictionary<string, List<XpsResource>>
        AddPageResources(IXpsFixedPageWriter fixedPageWriter)
    // Collection of all resources for this page. 
    //   Key: "XpsImage", "XpsFont" 
    //   Value: List of XpsImage or XpsFont
    Dictionary<string, List<XpsResource>> resources =
        new Dictionary<string, List<XpsResource>>();

    // Collections of images and fonts used in the current page.
    List<XpsResource> xpsImages = new List<XpsResource>();
    List<XpsResource> xpsFonts  = new List<XpsResource>();

        XpsImage xpsImage;
        XpsFont  xpsFont;

        // Add, Write, and Commit image1 to the current page.
        xpsImage = fixedPageWriter.AddImage(XpsImageType.JpegImageType);
        WriteToStream(xpsImage.GetStream(), image1);
        xpsImages.Add(xpsImage);    // Add image1 as a required resource. 

        // Add, Write, and Commit font 1 to the current page.
        xpsFont = fixedPageWriter.AddFont();
            xpsFont.Uri.ToString(), xpsFont.GetStream(), font1);
        xpsFonts.Add(xpsFont);      // Add font1 as a required resource. 

        // Add, Write, and Commit image2 to the current page.
        xpsImage = fixedPageWriter.AddImage(XpsImageType.TiffImageType);
        WriteToStream(xpsImage.GetStream(), image2);
        xpsImages.Add(xpsImage);    // Add image2 as a required resource. 

        // Add, Write, and Commit font2 to the current page.
        xpsFont = fixedPageWriter.AddFont(false);
        WriteToStream(xpsFont.GetStream(), font2);
        xpsFonts.Add(xpsFont);      // Add font2 as a required resource. 

        // Return the image and font resources in a combined collection.
        resources.Add("XpsImage", xpsImages);
        resources.Add("XpsFont", xpsFonts);
        return resources;
    catch (XpsPackagingException xpsException)
        throw xpsException;
}// end:AddPageResources()

For the complete sample, see Creating an XPS Document Sample.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0