ThumbnailGeneratingOptions class

ThumbnailGeneratingOptions class

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

Remarks

User can call method Document.update_thumbnail() to generate BuiltInDocumentProperties.thumbnail for a document.

Constructors

NameDescription
ThumbnailGeneratingOptions()The default constructor.

Properties

NameDescription
generate_from_first_pageSpecifies whether to generate thumbnail from first page of the document or first image.
thumbnail_sizeSize of generated thumbnail in pixels. Default is 600x900.

Examples

Shows how to update a document’s thumbnail.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)
builder.writeln('Hello world!')
builder.insert_image(file_name=IMAGE_DIR + '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.update_thumbnail()
doc.save(file_name=ARTIFACTS_DIR + 'Document.UpdateThumbnail.FirstPage.epub')
# 2 -  Use the first image found in the document:
options = aw.rendering.ThumbnailGeneratingOptions()
options.thumbnail_size = aspose.pydrawing.Size(400, 400)
options.generate_from_first_page = False
doc.update_thumbnail(options)
doc.save(file_name=ARTIFACTS_DIR + 'Document.UpdateThumbnail.FirstImage.epub')

See Also