BaseViewOptions Leave feedback

Inheritance: java.lang.Object

public abstract class BaseViewOptions

Contains the base rendering options.

The BaseViewOptions class serves as the base for rendering options in GroupDocs.Viewer. It allows you to customize the rendering behavior of the output HTML, PDF, PNG, and JPEG files when rendering specific document formats.

Note: For internal usage.

public BaseViewOptions()

public TextOptions getTextOptions()

Retrieves the options for splitting text files into pages.

For more information and code examples, see the documentation.

Returns: TextOptions - the text file splitting options.

public void setTextOptions(TextOptions textOptions)

Sets the options for splitting text files into pages.

For more information and code examples, see the documentation.

Parameters:

public final boolean isRenderComments()

Enables rendering comments.

By default, GroupDocs.Viewer does not render comments. To do this, set this property to true. For code example, see the documentation.

Returns: boolean - true if comments should be rendered, false otherwise.

public final void setRenderComments(boolean value)

Enables rendering comments.

By default, GroupDocs.Viewer does not render comments. To do this, set this property to true. For code example, see the documentation.

Parameters:

public final boolean isRemoveComments()

Disables rendering comments when set to true. By default is false \u2014 all comments are displayed.

Some document formats like PDF and WordProcessing may contain comments. By default the GroupDocs.Viewer renders them. With this option set to true the comments may be excluded from the resultant document. This option replaces the obsolete ‘RenderComments’ property.

Returns: boolean - true if comments should be rendered, false otherwise.

public final void setRemoveComments(boolean value)

Disables rendering comments when set to true. By default is false \u2014 all comments are displayed.

Some document formats like PDF and WordProcessing may contain comments. By default the GroupDocs.Viewer renders them. With this option set to true the comments may be excluded from the resultant document. This option replaces the obsolete ‘RenderComments’ property.

Parameters:

public final boolean isRenderNotes()

Enables rendering notes.

Some files, such as presentations or Microsoft project files, may contain notes. By default, GroupDocs.Viewer does not render notes. To do this, set this property to true. For code example, see the documentation.

Returns: boolean - true if notes should be rendered, false otherwise.

public final void setRenderNotes(boolean value)

Enables rendering notes.

Parameters:

public final boolean isRenderHiddenPages()

Enables rendering of hidden pages.

Some files, such as presentations or spreadsheets, may contain hidden pages. By default, GroupDocs.Viewer does not render these pages. To do this, set this property to true. For code example, see the documentation.

Returns: boolean - true if hidden pages should be rendered, false otherwise.

public final void setRenderHiddenPages(boolean value)

Enables rendering of hidden pages.

Some files, such as presentations or spreadsheets, may contain hidden pages. By default, GroupDocs.Viewer does not render these pages. To do this, set this property to true. For code example, see the documentation.

Parameters:

public final String getDefaultFontName()

Default font to be used when a particular font used in the document can’t be found.

Use this property to set the default font for a document. GroupDocs.Viewer uses this font during rendering instead of any not installed fonts. For code examples, see the documentation.

Returns: java.lang.String - the name of the default font.

public final void setDefaultFontName(String value)

Default font to be used when a particular font used in the document can’t be found.

Use this property to set the default font for a document. GroupDocs.Viewer uses this font during rendering instead of any not installed fonts. For code examples, see the documentation.

Parameters:

public final ArchiveOptions getArchiveOptions()

Retrieves the archive files view options.

For more information and code examples, see the documentation.

Returns: ArchiveOptions - the archive files view options.

public final void setArchiveOptions(ArchiveOptions value)

Sets the archive files view options.

For more information and code examples, see the documentation.

Parameters:

public final CadOptions getCadOptions()

Retrieves the CAD drawing view options.

For more information and code examples, see the Render CAD drawings and models as HTML, PDF, and image files and Specify rendering options for CAD files.

Returns: CadOptions - the CAD drawing view options.

public final void setCadOptions(CadOptions value)

Sets the CAD drawing view options.

For more information and code examples, see the Render CAD drawings and models as HTML, PDF, and image files and Specify rendering options for CAD files.

Parameters:

public boolean isCadOptionsInitialized_Internal()

Returns: boolean

public final EmailOptions getEmailOptions()

Retrieves the email messages view options.

For more information and code examples, see the documentation.

Returns: EmailOptions - Email messages view options.

public final void setEmailOptions(EmailOptions value)

Sets the email messages view options.

For more information and code examples, see the documentation.

Parameters:

public final OutlookOptions getOutlookOptions()

Retrieves the MS Outlook data files view options.

For more information and code examples, see the documentation.

Returns: OutlookOptions - MS Outlook data files view options.

public final void setOutlookOptions(OutlookOptions value)

Sets the MS Outlook data files view options.

For more information and code examples, see the documentation.

Parameters:

public final PdfOptions getPdfOptions()

Retrieves the PDF documents view options.

For more information and code examples, see the documentation.

Returns: PdfOptions - the PDF documents view options.

public final void setPdfOptions(PdfOptions value)

Retrieves the PDF documents view options.

For more information and code examples, see the documentation.

Parameters:

public MailStorageOptions getMailStorageOptions()

Retrieves the Lotus Notes storage data files view options.

Returns: MailStorageOptions - the Lotus Notes storage data files view options.

public void setMailStorageOptions(MailStorageOptions mailStorageOptions)

Sets the Lotus Notes storage data files view options.

Parameters:

public final ProjectManagementOptions getProjectManagementOptions()

Retrieves the project management files view options.

For more information and code examples, see the documentation.

Returns: ProjectManagementOptions - the project management files view options.

public final void setProjectManagementOptions(ProjectManagementOptions projectManagementOptions)

Sets the project management files view options.

For more information and code examples, see the documentation.

Parameters:

public final SpreadsheetOptions getSpreadsheetOptions()

Retrieves the spreadsheet files view options.

For more information and code examples, see the Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files, Split a worksheet into pages, and Specify spreadsheet rendering options.

Returns: SpreadsheetOptions - the spreadsheet files view options.

public final void setSpreadsheetOptions(SpreadsheetOptions value)

Sets the spreadsheet files view options.

For more information and code examples, see the Render Excel and Apple Numbers spreadsheets as HTML, PDF, and image files, Split a worksheet into pages, and Specify spreadsheet rendering options.

Parameters:

public final WordProcessingOptions getWordProcessingOptions()

The Word processing files view options.

For more information and code examples, see the documentation.

Returns: WordProcessingOptions - the Word processing options for rendering Word documents.

public final void setWordProcessingOptions(WordProcessingOptions wordProcessingOptions)

The Word processing files view options.

For more information and code examples, see the documentation.

Parameters:

public VisioRenderingOptions getVisioRenderingOptions()

Retrieves the rendering options for processing Visio files when viewing documents.

For more information and code examples, see the documentation.

Returns: VisioRenderingOptions - the Visio rendering options for processing Visio files.

public void setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions)

Sets the rendering options for processing Visio files when viewing documents.

For more information and code examples, see the documentation.

Parameters:

public PresentationOptions getPresentationOptions()

Retrieves the view options for processing presentation documents.

For more information and code examples, see the documentation.

Returns: com.groupdocs.viewer.options.PresentationOptions - the presentation view options for processing presentation documents.

public void setPresentationOptions(PresentationOptions presentationOptions)

Sets the view options for processing presentation documents.

For more information and code examples, see the documentation.

Parameters:

public WebDocumentOptions getWebDocumentOptions()

Gets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents.

For more information and code examples, see the documentation.

Returns: com.groupdocs.viewer.options.WebDocumentOptions - The WebDocumentOptions object for customizing the rendering options.

public void setWebDocumentOptions(WebDocumentOptions webDocumentOptions)

Sets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents.

For more information and code examples, see the documentation.

Parameters: