BaseViewOptions

Inheritance: java.lang.Object

public abstract class BaseViewOptions

Class that provides 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.

Constructors

Constructor Description
BaseViewOptions()

Methods

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

BaseViewOptions()

public BaseViewOptions()

getTextOptions()

public TextOptions getTextOptions()

Retrieves the options for splitting text files into pages.

Returns: TextOptions - the text file splitting options.

setTextOptions(TextOptions textOptions)

public void setTextOptions(TextOptions textOptions)

Sets the options for splitting text files into pages.

Parameters:

Parameter Type Description
textOptions TextOptions The text file splitting options.

isRenderComments()

public final boolean isRenderComments()

Enables rendering comments.

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

setRenderComments(boolean value)

public final void setRenderComments(boolean value)

Enables rendering comments.

Parameters:

Parameter Type Description
value boolean true if comments should be rendered, false otherwise.

isRenderNotes()

public final boolean isRenderNotes()

Enables rendering notes.

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

setRenderNotes(boolean value)

public final void setRenderNotes(boolean value)

Enables rendering notes.

Parameters:

Parameter Type Description
value boolean true if notes should be rendered, false otherwise.

isRenderHiddenPages()

public final boolean isRenderHiddenPages()

Enables rendering of hidden pages.

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

setRenderHiddenPages(boolean value)

public final void setRenderHiddenPages(boolean value)

Enables rendering of hidden pages.

Parameters:

Parameter Type Description
value boolean true if hidden pages should be rendered, false otherwise.

getDefaultFontName()

public final String getDefaultFontName()

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

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

setDefaultFontName(String value)

public final void setDefaultFontName(String value)

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

Parameters:

Parameter Type Description
value java.lang.String The name of the default font.

getArchiveOptions()

public final ArchiveOptions getArchiveOptions()

Retrieves the archive files view options.

Returns: ArchiveOptions - the archive files view options.

setArchiveOptions(ArchiveOptions value)

public final void setArchiveOptions(ArchiveOptions value)

Sets the archive files view options.

Parameters:

Parameter Type Description
value ArchiveOptions The archive files view options.

getCadOptions()

public final CadOptions getCadOptions()

Retrieves the CAD drawing view options.

Returns: CadOptions - the CAD drawing view options.

setCadOptions(CadOptions value)

public final void setCadOptions(CadOptions value)

Sets the CAD drawing view options.

Parameters:

Parameter Type Description
value CadOptions The CAD drawing view options.

isCadOptionsInitialized_Internal()

public boolean isCadOptionsInitialized_Internal()

Returns: boolean

getEmailOptions()

public final EmailOptions getEmailOptions()

Retrieves the email messages view options.

Returns: EmailOptions - Email messages view options.

setEmailOptions(EmailOptions value)

public final void setEmailOptions(EmailOptions value)

Sets the email messages view options.

Parameters:

Parameter Type Description
value EmailOptions Email messages view options.

getOutlookOptions()

public final OutlookOptions getOutlookOptions()

Retrieves the MS Outlook data files view options.

Returns: OutlookOptions - MS Outlook data files view options.

setOutlookOptions(OutlookOptions value)

public final void setOutlookOptions(OutlookOptions value)

Sets the MS Outlook data files view options.

Parameters:

Parameter Type Description
value OutlookOptions The MS Outlook data files view options to set.

getPdfOptions()

public final PdfOptions getPdfOptions()

Retrieves the PDF documents view options.

Returns: PdfOptions - the PDF documents view options.

setPdfOptions(PdfOptions value)

public final void setPdfOptions(PdfOptions value)

Retrieves the PDF documents view options.

Parameters:

Parameter Type Description
value PdfOptions The PDF documents view options.

getMailStorageOptions()

public MailStorageOptions getMailStorageOptions()

Retrieves the Lotus Notes storage data files view options.

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

setMailStorageOptions(MailStorageOptions mailStorageOptions)

public void setMailStorageOptions(MailStorageOptions mailStorageOptions)

Sets the Lotus Notes storage data files view options.

Parameters:

Parameter Type Description
mailStorageOptions MailStorageOptions The Lotus Notes storage data files view options.

getProjectManagementOptions()

public final ProjectManagementOptions getProjectManagementOptions()

Retrieves the project management files view options.

Returns: ProjectManagementOptions - the project management files view options.

setProjectManagementOptions(ProjectManagementOptions projectManagementOptions)

public final void setProjectManagementOptions(ProjectManagementOptions projectManagementOptions)

Sets the project management files view options.

Parameters:

Parameter Type Description
projectManagementOptions ProjectManagementOptions The project management files view options to be set.

getSpreadsheetOptions()

public final SpreadsheetOptions getSpreadsheetOptions()

Retrieves the spreadsheet files view options.

Returns: SpreadsheetOptions - the spreadsheet files view options.

setSpreadsheetOptions(SpreadsheetOptions value)

public final void setSpreadsheetOptions(SpreadsheetOptions value)

Sets the spreadsheet files view options.

Parameters:

Parameter Type Description
value SpreadsheetOptions The spreadsheet files view options.

getWordProcessingOptions()

public final WordProcessingOptions getWordProcessingOptions()

Retrieves the rendering options for customizing the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents.

Note: See also Render Word documents as HTML, PDF, or image files

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

setWordProcessingOptions(WordProcessingOptions wordProcessingOptions)

public final void setWordProcessingOptions(WordProcessingOptions wordProcessingOptions)

Sets the rendering options for customizing the appearance of the output HTML/PDF/PNG/JPEG when rendering Word documents.

Note: See also Render Word documents as HTML, PDF, or image files

Parameters:

Parameter Type Description
wordProcessingOptions WordProcessingOptions The Word processing options for rendering Word documents.

getVisioRenderingOptions()

public VisioRenderingOptions getVisioRenderingOptions()

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

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

setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions)

public void setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions)

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

Parameters:

Parameter Type Description
visioRenderingOptions VisioRenderingOptions The Visio rendering options for processing Visio files.

getPresentationOptions()

public PresentationOptions getPresentationOptions()

Retrieves the view options for processing presentation documents.

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

setPresentationOptions(PresentationOptions presentationOptions)

public void setPresentationOptions(PresentationOptions presentationOptions)

Sets the view options for processing presentation documents.

Parameters:

Parameter Type Description
presentationOptions com.groupdocs.viewer.options.PresentationOptions The presentation view options for processing presentation documents.

getWebDocumentOptions()

public WebDocumentOptions getWebDocumentOptions()

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

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

setWebDocumentOptions(WebDocumentOptions webDocumentOptions)

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.

Parameters:

Parameter Type Description
webDocumentOptions com.groupdocs.viewer.options.WebDocumentOptions The WebDocumentOptions object for customizing the rendering options.