public class CachedPageDescription extends CacheFileDescription
Class that describes cached document page.
Constructor and Description |
---|
CachedPageDescription(String guid)
Initializes a new instance of the
CachedPageDescription class. |
CachedPageDescription(String guid,
String name)
Initializes a new instance of the
CachedPageDescription class. |
Modifier and Type | Method and Description |
---|---|
ArchiveOptions |
getArchiveOptions()
Gets or sets the Archive file rendering options.
|
CadOptions |
getCadOptions()
The CAD documents rendering options.
|
CellsOptions |
getCellsOptions()
The Spreadsheet documents rendering options.
|
EmailOptions |
getEmailOptions()
The Email documents rendering options.
|
boolean |
getExtractText()
Indicates whether the document text has been extracted.
|
int |
getHeight()
The page height.
|
int |
getJpegQuality()
The JPEG quality.
|
OutlookOptions |
getOutlookOptions()
Gets or sets the Outlook Data File document rendering options.
|
String |
getOutputExtension()
The extension of the cached file.
|
int |
getPageNumber()
The page number.
|
PdfOptions |
getPdfOptions()
The PDF documents rendering options.
|
ProjectOptions |
getProjectOptions()
Gets or sets the Project document rendering options.
|
SlidesOptions |
getSlidesOptions()
The Presentation documents rendering options.
|
int |
getWidth()
The page width.
|
WordsOptions |
getWordsOptions()
The Text documents rendering options.
|
void |
setArchiveOptions(ArchiveOptions value)
Gets or sets the Archive file rendering options.
|
void |
setCadOptions(CadOptions value)
The CAD documents rendering options.
|
void |
setCellsOptions(CellsOptions value)
The Spreadsheet documents rendering options.
|
void |
setEmailOptions(EmailOptions value)
The Email documents rendering options.
|
void |
setExtractText(boolean value)
Indicates whether the document text has been extracted.
|
void |
setHeight(int value)
The page height.
|
void |
setJpegQuality(int value)
The JPEG quality.
|
void |
setOutlookOptions(OutlookOptions value)
Gets or sets the Outlook Data File document rendering options.
|
void |
setOutputExtension(String value)
The extension of the cached file.
|
void |
setPageNumber(int value)
The page number.
|
void |
setPdfOptions(PdfOptions value)
The PDF documents rendering options.
|
void |
setProjectOptions(ProjectOptions value)
Gets or sets the Project document rendering options.
|
void |
setSlidesOptions(SlidesOptions value)
The Presentation documents rendering options.
|
void |
setWidth(int value)
The page width.
|
void |
setWordsOptions(WordsOptions value)
The Text documents rendering options.
|
getCacheFileType, setCacheFileType
getExtension, getFileFormat, getGuid, getLastModificationDate, getName, getSize, isDirectory, setDirectory, setGuid, setLastModificationDate, setLastModificationDate, setName, setSize
public CachedPageDescription(String guid)
Initializes a new instance of the CachedPageDescription
class.
guid
- The file unique identifier, full path for local storage e.g. c:\\storage\\document.txt,
relative path e.g document.txt, url e.g. http://site.com/document.txtpublic CachedPageDescription(String guid, String name)
Initializes a new instance of the CachedPageDescription
class.
guid
- The file unique identifier, full path for local storage e.g. c:\\storage\\document.txt,
relative path e.g document.txt, url e.g. http://site.com/document.txtname
- File name with extensionpublic ArchiveOptions getArchiveOptions()
Gets or sets the Archive file rendering options.
value
- The Archive file options.public CadOptions getCadOptions()
The CAD documents rendering options.
public CellsOptions getCellsOptions()
The Spreadsheet documents rendering options.
public EmailOptions getEmailOptions()
The Email documents rendering options.
public boolean getExtractText()
Indicates whether the document text has been extracted.
public int getHeight()
The page height.
public int getJpegQuality()
The JPEG quality.
public OutlookOptions getOutlookOptions()
Gets or sets the Outlook Data File document rendering options.
public String getOutputExtension()
The extension of the cached file.
public int getPageNumber()
The page number.
public PdfOptions getPdfOptions()
The PDF documents rendering options.
public ProjectOptions getProjectOptions()
Gets or sets the Project document rendering options.
public SlidesOptions getSlidesOptions()
The Presentation documents rendering options.
public int getWidth()
The page width.
public WordsOptions getWordsOptions()
The Text documents rendering options.
public void setArchiveOptions(ArchiveOptions value)
Gets or sets the Archive file rendering options.
value
- The Archive file options.public void setCadOptions(CadOptions value)
The CAD documents rendering options.
value
- The CAD documents rendering options.public void setCellsOptions(CellsOptions value)
The Spreadsheet documents rendering options.
value
- The Spreadsheet documents rendering options.public void setEmailOptions(EmailOptions value)
The Email documents rendering options.
value
- The Email documents rendering options.public void setExtractText(boolean value)
Indicates whether the document text has been extracted.
value
- public void setHeight(int value)
The page height.
value
- The page height.public void setJpegQuality(int value)
The JPEG quality.
value
- The JPEG quality.public void setOutlookOptions(OutlookOptions value)
Gets or sets the Outlook Data File document rendering options.
value
- The Outlook Data File options.public void setOutputExtension(String value)
The extension of the cached file.
value
- The output extension.public void setPageNumber(int value)
The page number.
value
- The page number.public void setPdfOptions(PdfOptions value)
The PDF documents rendering options.
value
- The PDF documents rendering options.public void setProjectOptions(ProjectOptions value)
Gets or sets the Project document rendering options.
value
- The Project options.public void setSlidesOptions(SlidesOptions value)
The Presentation documents rendering options.
value
- The Presentation documents rendering options.public void setWidth(int value)
The page width.
value
- The page width.public void setWordsOptions(WordsOptions value)
The Text documents rendering options.
value
- The Text documents rendering options.