BaseViewOptions (GroupDocs.Total for Java (24.10) API Reference)

java.lang.Object
- com.groupdocs.viewer.options.BaseViewOptions

Direct Known Subclasses:

ViewInfoOptions, ViewOptions
```
public abstract class BaseViewOptions
extends Object
```
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.

See Also:

HtmlViewOptions, PdfViewOptions, JpgViewOptions

Constructor Summary

Constructors
Constructor and Description

BaseViewOptions()

Constructors
Constructor and Description
`BaseViewOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ArchiveOptions`	`getArchiveOptions()` Retrieves the archive files view options.
`CadOptions`	`getCadOptions()` Retrieves the CAD drawing view options.
`String`	`getDefaultFontName()` Default font to be used when a particular font used in the document can't be found.
`EmailOptions`	`getEmailOptions()` Retrieves the email messages view options.
`MailStorageOptions`	`getMailStorageOptions()` Retrieves the Lotus Notes storage data files view options.
`OutlookOptions`	`getOutlookOptions()` Retrieves the MS Outlook data files view options.
`PdfOptions`	`getPdfOptions()` Retrieves the PDF documents view options.
`com.groupdocs.viewer.options.PresentationOptions`	`getPresentationOptions()` Retrieves the view options for processing presentation documents.
`ProjectManagementOptions`	`getProjectManagementOptions()` Retrieves the project management files view options.
`SpreadsheetOptions`	`getSpreadsheetOptions()` Retrieves the spreadsheet files view options.
`TextOptions`	`getTextOptions()` Retrieves the options for splitting text files into pages.
`VisioRenderingOptions`	`getVisioRenderingOptions()` Retrieves the rendering options for processing Visio files when viewing documents.
`com.groupdocs.viewer.options.WebDocumentOptions`	`getWebDocumentOptions()` Gets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents.
`WordProcessingOptions`	`getWordProcessingOptions()` The Word processing files view options.
`boolean`	`isCadOptionsInitialized_Internal()`
`boolean`	`isRenderComments()` Enables rendering comments.
`boolean`	`isRenderHiddenPages()` Enables rendering of hidden pages.
`boolean`	`isRenderNotes()` Enables rendering notes.
`void`	`setArchiveOptions(ArchiveOptions value)` Sets the archive files view options.
`void`	`setCadOptions(CadOptions value)` Sets the CAD drawing view options.
`void`	`setDefaultFontName(String value)` Default font to be used when a particular font used in the document can't be found.
`void`	`setEmailOptions(EmailOptions value)` Sets the email messages view options.
`void`	`setMailStorageOptions(MailStorageOptions mailStorageOptions)` Sets the Lotus Notes storage data files view options.
`void`	`setOutlookOptions(OutlookOptions value)` Sets the MS Outlook data files view options.
`void`	`setPdfOptions(PdfOptions value)` Retrieves the PDF documents view options.
`void`	`setPresentationOptions(com.groupdocs.viewer.options.PresentationOptions presentationOptions)` Sets the view options for processing presentation documents.
`void`	`setProjectManagementOptions(ProjectManagementOptions projectManagementOptions)` Sets the project management files view options.
`void`	`setRenderComments(boolean value)` Enables rendering comments.
`void`	`setRenderHiddenPages(boolean value)` Enables rendering of hidden pages.
`void`	`setRenderNotes(boolean value)` Enables rendering notes.
`void`	`setSpreadsheetOptions(SpreadsheetOptions value)` Sets the spreadsheet files view options.
`void`	`setTextOptions(TextOptions textOptions)` Sets the options for splitting text files into pages.
`void`	`setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions)` Sets the rendering options for processing Visio files when viewing documents.
`void`	`setWebDocumentOptions(com.groupdocs.viewer.options.WebDocumentOptions webDocumentOptions)` Sets the rendering options that allow customization of the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents.
`void`	`setWordProcessingOptions(WordProcessingOptions wordProcessingOptions)` The Word processing files view options.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BaseViewOptions
```
public BaseViewOptions()
```
- Method Detail
  - getArchiveOptions
```
public final ArchiveOptions getArchiveOptions()
```
    Retrieves the archive files view options.
    
    For more information and code examples, see the documentation.
    
    Returns:
    
    the archive files view options.
  - getCadOptions
```
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:
    
    the CAD drawing view options.
  - getDefaultFontName
```
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:
    
    the name of the default font.
  - getEmailOptions
```
public final EmailOptions getEmailOptions()
```
    Retrieves the email messages view options.
    
    For more information and code examples, see the documentation.
    
    Returns:
    
    Email messages view options.
  - getMailStorageOptions
```
public MailStorageOptions getMailStorageOptions()
```
    Retrieves the Lotus Notes storage data files view options.
    
    Returns:
    
    the Lotus Notes storage data files view options.
  - getOutlookOptions
```
public final OutlookOptions getOutlookOptions()
```
    Retrieves the MS Outlook data files view options.
    
    For more information and code examples, see the documentation.
    
    Returns:
    
    MS Outlook data files view options.
  - getPdfOptions
```
public final PdfOptions getPdfOptions()
```
    Retrieves the PDF documents view options.
    
    For more information and code examples, see the documentation.
    
    Returns:
    
    the PDF documents view options.
  - getPresentationOptions
```
public com.groupdocs.viewer.options.PresentationOptions getPresentationOptions()
```
    Retrieves the view options for processing presentation documents.
    
    For more information and code examples, see the documentation.
    
    Returns:
    
    the presentation view options for processing presentation documents.
  - getProjectManagementOptions
```
public final ProjectManagementOptions getProjectManagementOptions()
```
    Retrieves the project management files view options.
    
    For more information and code examples, see the documentation.
    
    Returns:
    
    the project management files view options.
  - getSpreadsheetOptions
```
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:
    
    the spreadsheet files view options.
  - getTextOptions
```
public TextOptions getTextOptions()
```
    Retrieves the options for splitting text files into pages.
    
    For more information and code examples, see the documentation.
    
    Returns:
    
    the text file splitting options.
  - getVisioRenderingOptions
```
public VisioRenderingOptions getVisioRenderingOptions()
```
    Retrieves the rendering options for processing Visio files when viewing documents.
    
    For more information and code examples, see the documentation.
    
    Returns:
    
    the Visio rendering options for processing Visio files.
  - getWebDocumentOptions
```
public com.groupdocs.viewer.options.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:
    
    The WebDocumentOptions object for customizing the rendering options.
  - getWordProcessingOptions
```
public final WordProcessingOptions getWordProcessingOptions()
```
    The Word processing files view options.
    
    For more information and code examples, see the documentation.
    
    Returns:
    
    the Word processing options for rendering Word documents.
  - isCadOptionsInitialized_Internal
```
public boolean isCadOptionsInitialized_Internal()
```
  - isRenderComments
```
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:
    
    true if comments should be rendered, false otherwise.
  - isRenderHiddenPages
```
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:
    
    true if hidden pages should be rendered, false otherwise.
  - isRenderNotes
```
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:
    
    true if notes should be rendered, false otherwise.
  - setArchiveOptions
```
public final void setArchiveOptions(ArchiveOptions value)
```
    Sets the archive files view options.
    
    For more information and code examples, see the documentation.
    
    Parameters:
    
    value - The archive files view options.
  - setCadOptions
```
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:
    
    value - The CAD drawing view options.
  - setDefaultFontName
```
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:
    
    value - The name of the default font.
  - setEmailOptions
```
public final void setEmailOptions(EmailOptions value)
```
    Sets the email messages view options.
    
    For more information and code examples, see the documentation.
    
    Parameters:
    
    value - Email messages view options.
  - setMailStorageOptions
```
public void setMailStorageOptions(MailStorageOptions mailStorageOptions)
```
    Sets the Lotus Notes storage data files view options.
    
    Parameters:
    
    mailStorageOptions - The Lotus Notes storage data files view options.
  - setOutlookOptions
```
public final void setOutlookOptions(OutlookOptions value)
```
    Sets the MS Outlook data files view options.
    
    For more information and code examples, see the documentation.
    
    Parameters:
    
    value - The MS Outlook data files view options to set.
  - setPdfOptions
```
public final void setPdfOptions(PdfOptions value)
```
    Retrieves the PDF documents view options.
    
    For more information and code examples, see the documentation.
    
    Parameters:
    
    value - The PDF documents view options.
  - setPresentationOptions
```
public void setPresentationOptions(com.groupdocs.viewer.options.PresentationOptions presentationOptions)
```
    Sets the view options for processing presentation documents.
    
    For more information and code examples, see the documentation.
    
    Parameters:
    
    presentationOptions - The presentation view options for processing presentation documents.
  - setProjectManagementOptions
```
public final void setProjectManagementOptions(ProjectManagementOptions projectManagementOptions)
```
    Sets the project management files view options.
    
    For more information and code examples, see the documentation.
    
    Parameters:
    
    projectManagementOptions - The project management files view options to be set.
  - setRenderComments
```
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:
    
    value - true if comments should be rendered, false otherwise.
  - setRenderHiddenPages
```
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:
    
    value - true if hidden pages should be rendered, false otherwise.
  - setRenderNotes
```
public final void setRenderNotes(boolean value)
```
    Enables rendering notes.
    
    Parameters:
    
    value - true if notes should be rendered, false otherwise.
  - setSpreadsheetOptions
```
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:
    
    value - The spreadsheet files view options.
  - setTextOptions
```
public void setTextOptions(TextOptions textOptions)
```
    Sets the options for splitting text files into pages.
    
    For more information and code examples, see the documentation.
    
    Parameters:
    
    textOptions - The text file splitting options.
  - setVisioRenderingOptions
```
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:
    
    visioRenderingOptions - The Visio rendering options for processing Visio files.
  - setWebDocumentOptions
```
public void setWebDocumentOptions(com.groupdocs.viewer.options.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:
    
    webDocumentOptions - The WebDocumentOptions object for customizing the rendering options.
  - setWordProcessingOptions
```
public final void setWordProcessingOptions(WordProcessingOptions wordProcessingOptions)
```
    The Word processing files view options.
    
    For more information and code examples, see the documentation.
    
    Parameters:
    
    wordProcessingOptions - The Word processing options for rendering Word documents.

Class BaseViewOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseViewOptions

Method Detail

getArchiveOptions

getCadOptions

getDefaultFontName

getEmailOptions

getMailStorageOptions

getOutlookOptions

getPdfOptions

getPresentationOptions

getProjectManagementOptions

getSpreadsheetOptions

getTextOptions

getVisioRenderingOptions

getWebDocumentOptions

getWordProcessingOptions

isCadOptionsInitialized_Internal

isRenderComments

isRenderHiddenPages

isRenderNotes

setArchiveOptions

setCadOptions

setDefaultFontName

setEmailOptions

setMailStorageOptions

setOutlookOptions

setPdfOptions

setPresentationOptions

setProjectManagementOptions

setRenderComments

setRenderHiddenPages

setRenderNotes

setSpreadsheetOptions

setTextOptions

setVisioRenderingOptions

setWebDocumentOptions

setWordProcessingOptions