ThumbnailGeneratingOptions

ThumbnailGeneratingOptions class

Can be used to specify additional options when generating thumbnail for a document.

public class ThumbnailGeneratingOptions

Constructors

Name Description
ThumbnailGeneratingOptions() The default constructor.

Properties

Name Description
GenerateFromFirstPage { get; set; } Specifies whether to generate thumbnail from first page of the document or first image.
ThumbnailSize { get; set; } Size of generated thumbnail in pixels. Default is 600x900.

Remarks

User can call method UpdateThumbnail to generate Thumbnail for a document.

Examples

Shows how to update a document’s thumbnail.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.Writeln("Hello world!");
builder.InsertImage(ImageDir + "Logo.jpg");

// There are two ways of setting a thumbnail image when saving a document to .epub.
// 1 -  Use the document's first page:
doc.UpdateThumbnail();
doc.Save(ArtifactsDir + "Document.UpdateThumbnail.FirstPage.epub");

// 2 -  Use the first image found in the document:
ThumbnailGeneratingOptions options = new ThumbnailGeneratingOptions();
options.ThumbnailSize = new Size(400, 400);
options.GenerateFromFirstPage = false;

doc.UpdateThumbnail(options);
doc.Save(ArtifactsDir + "Document.UpdateThumbnail.FirstImage.epub");

See Also