XpsImage Class

XpsImage Class


Represents an image in an XpsDocument.

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

public class XpsImage : XpsResource


Gets or sets the uniform resource identifier (URI) of the part.(Inherited from XpsPartBase.)


Commits all changes and flushes the resource to the document package.(Inherited from XpsResource.)


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


When overridden in a derived class, returns the I/O stream for reading or writing the resource. (Inherited from XpsResource.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns the URI of the resource that is relative to a specified absolute URI.(Inherited from XpsResource.)


Returns a string that represents the current object.(Inherited from Object.)


This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from XpsResource.)

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()

.NET Framework
Available since 3.0

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

Return to top
© 2015 Microsoft