Constructor and Description |
---|
ViewerConfig() |
Modifier and Type | Method and Description |
---|---|
String |
getCacheFolderName()
The name of the cache folder.
|
String |
getCachePath()
The path to the directory, where the cache will be stored.
|
com.groupdocs.viewer.config.EngineTypes |
getEngineType()
Current viewer engine.
|
String |
getLocalesPath()
The path to locales.
|
String |
getPageNamePrefix()
The prefix for generated page name.
|
String |
getStoragePath()
The path to the documents storage directory.
|
String |
getTempFolderName()
Deprecated.
|
String |
getTempPath()
Deprecated.
|
boolean |
getUseCache()
Indicates whether to cache rendering results or not.
|
boolean |
getUsePdf()
Indicates whether to use intermediate conversion to PDF when rendering document.
|
void |
setCacheFolderName(String value)
The name of the cache folder.
|
void |
setCachePath(String value)
The path to the directory, where the cache will be stored.
|
void |
setEngineType(com.groupdocs.viewer.config.EngineTypes value)
Current viewer engine.
|
void |
setLocalesPath(String value)
The path to locales.
|
void |
setPageNamePrefix(String value)
The prefix for generated page name.
|
void |
setStoragePath(String value)
The path to the documents storage directory.
|
void |
setTempFolderName(String value)
Deprecated.
|
void |
setTempPath(String value)
Deprecated.
|
void |
setUseCache(boolean value)
Indicates whether to cache rendering results or not.
|
void |
setUsePdf(boolean value)
Indicates whether to use intermediate conversion to PDF when rendering document.
|
public String getStoragePath()
The path to the documents storage directory.
The following example demonstrates how to set the storage path and render document located inside the storage directory. Storage path acts as a base location in the file system, for the documents rendering. When the full path to the document is not provided, API assumes that the document is located in the storage directory. By default, cache files are stored in the folder, inside the storage directory.String
object.public void setStoragePath(String value)
The path to the documents storage directory.
The following example demonstrates how to set the storage path and render document located inside the storage directory. Storage path acts as a base location in the file system, for the documents rendering. When the full path to the document is not provided, API assumes that the document is located in the storage directory. By default, cache files are stored in the folder, inside the storage directory.value
- a String
object.public String getCacheFolderName()
The name of the cache folder.
The following example demonstrates how to set cache folder name. As the cache path has not been set, cache will be stored inside the 'C:\storage\cachefolder\'. When the cache path is not set, cache will be stored in the directory with the cache folder name inside the storage directory.String
object.public void setCacheFolderName(String value)
The name of the cache folder.
The following example demonstrates how to set cache folder name. As the cache path has not been set, cache will be stored inside the 'C:\storage\cachefolder\'. When the cache path is not set, cache will be stored in the directory with the cache folder name inside the storage directory.value
- a String
object.@Deprecated public String getTempFolderName()
The temp folder name.
String
object.@Deprecated public void setTempFolderName(String value)
The temp folder name.
value
- a String
object.public String getCachePath()
The path to the directory, where the cache will be stored.
The following example demonstrates how to set the cache path. When the cache path is set, the cache folder name will be ignored.String
object.public void setCachePath(String value)
The path to the directory, where the cache will be stored.
The following example demonstrates how to set the cache path. When the cache path is set, the cache folder name will be ignored.value
- a String
object.@Deprecated public String getTempPath()
The temp folder path.
String
object.@Deprecated public void setTempPath(String value)
The temp folder path.
value
- a String
object.public boolean getUseCache()
Indicates whether to cache rendering results or not.
The following example demonstrates how to enable caching. Using cache will let to avoid processing the same document more than once.public void setUseCache(boolean value)
Indicates whether to cache rendering results or not.
The following example demonstrates how to enable caching. Using cache will let to avoid processing the same document more than once.value
- a boolean.public boolean getUsePdf()
Indicates whether to use intermediate conversion to PDF when rendering document.
The following example demonstrates how to enable intermediate conversion to PDF. When intermediate conversion to PDF is used, the file data will contain the text with coordinates. This might be useful when you want to add selectable text layer over the image. Rendering in this mode is slower.public void setUsePdf(boolean value)
Indicates whether to use intermediate conversion to PDF when rendering document.
The following example demonstrates how to enable intermediate conversion to PDF. When intermediate conversion to PDF is used, the file data will contain the text with coordinates. This might be useful when you want to add selectable text layer over the image. Rendering in this mode is slower.value
- a boolean.public String getLocalesPath()
The path to locales.
The following example demonstrates how to set locales path. Locales (xml files with localized strings) if present, will be loaded from locales path directory. Files inside this directory should have the following naming convention: "LocalizedStrings-{Language Culture Name}.xml" where {Language Culture Name} is your culture name e.g. "fr-FR". To learn more<a href="http://www.groupdocs.com/docs/display/viewernet/Working+to+Create+and+Use+File+with+Localized+Strings">press here</a>
.String
object.public void setLocalesPath(String value)
The path to locales.
The following example demonstrates how to set locales path. Locales (xml files with localized strings) if present, will be loaded from locales path directory. Files inside this directory should have the following naming convention: "LocalizedStrings-{Language Culture Name}.xml" where {Language Culture Name} is your culture name e.g. "fr-FR". To learn more<a href="http://www.groupdocs.com/docs/display/viewernet/Working+to+Create+and+Use+File+with+Localized+Strings">press here</a>
.value
- a String
object.public com.groupdocs.viewer.config.EngineTypes getEngineType()
Current viewer engine.
EngineTypes
object.public void setEngineType(com.groupdocs.viewer.config.EngineTypes value)
Current viewer engine.
value
- a EngineTypes
object.public String getPageNamePrefix()
The prefix for generated page name. Default is "page".
The following example demonstrates how to set the page name prefix. The page name prefix is used for naming files in the cache.String
object.Copyright © 2018. All rights reserved.