IXpsFixedPageWriter.AddThumbnail(XpsImageType) Method

Reference

Definition

Namespace:: System.Windows.Xps.Packaging

Assembly:: ReachFramework.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Adds a thumbnail image of a specified XpsImageType to the current page.

public:
 System::Windows::Xps::Packaging::XpsThumbnail ^ AddThumbnail(System::Windows::Xps::Packaging::XpsImageType imageType);

public System.Windows.Xps.Packaging.XpsThumbnail AddThumbnail (System.Windows.Xps.Packaging.XpsImageType imageType);

abstract member AddThumbnail : System.Windows.Xps.Packaging.XpsImageType -> System.Windows.Xps.Packaging.XpsThumbnail

Public Function AddThumbnail (imageType As XpsImageType) As XpsThumbnail

Parameters

imageType: XpsImageType

The image type of the thumbnail image to add to the page.

Returns

XpsThumbnail

The new thumbnail image resource that was added.

Exceptions

InvalidOperationException

AddThumbnail(XpsImageType) has already been called to add an image thumbnail for this page.

ObjectDisposedException

Dispose() has been called.

Remarks

AddThumbnail adds a new XpsImageType to the document package and associates it with the current FixedPage.

For example, imageType can be JpegImageType or PngImageType. to add a JPEG or PNG thumbnail image, respectively.

Notes to Implementers

Each page can only contain with one thumbnail. An InvalidOperationException is thrown if AddThumbnail(XpsImageType) is called to add more than one thumbnail image for the page.

Applies to