ViewInfoOptions class

ViewInfoOptions class

The options used to retrieve view information.

The ViewInfoOptions type exposes the following members:

Methods

Method Description
for_html_view Initializes a ViewInfoOptions instance for retrieving view information when rendering to HTML.
for_html_view Initializes a ViewInfoOptions instance for retrieving view information when rendering to HTML.
for_html_view_boolean
for_jpg_view Initializes a ViewInfoOptions instance to retrieve information about view when rendering into JPG.
for_jpg_view Initializes a ViewInfoOptions instance for retrieving view information when rendering to JPG.
for_jpg_view_boolean
for_pdf_view Initializes a ViewInfoOptions instance for retrieving view information when rendering to PDF.
for_png_view Initializes an instance of the ViewInfoOptions class to retrieve information about view when rendering into PNG.
for_png_view Initializes an instance of the ViewInfoOptions class to retrieve information about view when rendering into PNG.
for_png_view_boolean
from_html_view_options Initializes an instance of the ViewInfoOptions class based on the HtmlViewOptions object.
from_jpg_view_options Initializes a ViewInfoOptions instance based on the provided JpgViewOptions.
from_pdf_view_options Initializes a ViewInfoOptions instance from a PdfViewOptions object.
from_png_view_options Initializes a ViewInfoOptions instance from a PngViewOptions object.

Properties

Property Description
extract_text The property enables text extraction.
height The height of the output image (in pixels, for rendering to PNG/JPG only).
max_height The maximum height of an output image (in pixels, for rendering to PNG/JPG only).
max_width The maximum width of an output image in pixels (for rendering to PNG/JPG only).
width The width of the output image (in pixels, for rendering to PNG/JPG only).
archive_options The archive files view options. (inherited from BaseViewOptions)
cad_options The CAD drawing view options. (inherited from BaseViewOptions)
default_font_name The default font for a document used during rendering when a required font is missing. (inherited from BaseViewOptions)
email_options The email messages view options. (inherited from BaseViewOptions)
mail_storage_options The mail storage data files view options. (inherited from BaseViewOptions)
outlook_options The Microsoft Outlook data files view options. (inherited from BaseViewOptions)
pdf_options The PDF document view options. (inherited from BaseViewOptions)
presentation_options The presentation files view options. (inherited from BaseViewOptions)
project_management_options The project management files view options. (inherited from BaseViewOptions)
remove_comments The property disables rendering comments when set to True. By default it is False, so all comments are displayed. (inherited from BaseViewOptions)
render_comments The property enables or disables rendering comments. (inherited from BaseViewOptions)
render_hidden_pages The property enables rendering of hidden pages. (inherited from BaseViewOptions)
render_notes The property enables rendering notes and annotations for some formats. (inherited from BaseViewOptions)
spreadsheet_options The spreadsheet files view options. (inherited from BaseViewOptions)
text_options The text options for rendering text files. (inherited from BaseViewOptions)
visio_rendering_options The Visio files view options. (inherited from BaseViewOptions)
web_document_options The Web files view options. (inherited from BaseViewOptions)
word_processing_options The Word processing files view options. (inherited from BaseViewOptions)

Example

from groupdocs.viewer import Viewer
from groupdocs.viewer.options import ViewInfoOptions

with Viewer("sample.pdf") as viewer:
    info = viewer.get_view_info(ViewInfoOptions.for_html_view())
    print("Document type:", info.file_type)
    print("Pages count:", len(info.pages))

Guides

Task guides that use ViewInfoOptions:

See Also