IXpsFixedDocumentSequenceWriter.AddThumbnail(XpsImageType) Method

Definition

Adds an XpsThumbnail image for the FixedDocumentSequence.

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

Returns

The new XpsThumbnail for the FixedDocumentSequence.

Remarks

For example, the imageType might be JpegImageType or PngImageType.

Notes to Implementers

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

Applies to