IXpsFixedDocumentWriter.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 an XpsThumbnail image for the FixedDocument.

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 to add.

Returns

XpsThumbnail

The new XpsThumbnail for the FixedDocument.

Remarks

For example, the imageType might be JpegImageType or PngImageType.

Notes to Implementers

Only one thumbnail image can represent the document as a whole (although individual pages can have their own thumbnail images). An InvalidOperationException is thrown if AddThumbnail(XpsImageType) is called when the document already has a thumbnail.

Applies to