LoadOptions
LoadOptions class
Allows to specify additional options (such as format or default font) when loading a presentation.
LoadOptions
| Name | Description |
|---|---|
| LoadOptions() | Creates new default load options. |
Returns: LoadOptions
LoadOptions
| Name | Description |
|---|---|
| LoadOptions(int) | Creates new load options. |
Parameters:
| Name | Type | Description |
|---|---|---|
| loadFormat | int | Format of a presentation to load. |
Returns: LoadOptions
getBlobManagementOptions
| Name | Description |
|---|---|
| getBlobManagementOptions () | Represents the options which can be used to manage Binary Large Objects (BLOBs) handling behavior, such as using of temporary files or max BLOBs bytes in memory. These options intended to set up the best performance/memory consumption ratio for a perticular environment or requirements. A Binary Large Object (BLOB) is a binary data stored as a single entity - i.e. BLOB can be an audio, video or presentation itself. |
Returns: BlobManagementOptions
getDefaultAsianFont
| Name | Description |
|---|---|
| getDefaultAsianFont () | Returns or sets Asian font used in case source font is not found. Read/write String. |
Returns: String
getDefaultRegularFont
| Name | Description |
|---|---|
| getDefaultRegularFont () | Returns or sets Regular font used in case source font is not found. Read/write String. |
Returns: String
getDefaultSymbolFont
| Name | Description |
|---|---|
| getDefaultSymbolFont () | Returns or sets Symbol font used in case source font is not found. Read/write String. |
Returns: String
getDefaultTextLanguage
| Name | Description |
|---|---|
| getDefaultTextLanguage () | Returns or sets the default language for presentation text. Read/write String. |
Returns: String
getDocumentLevelFontSources
| Name | Description |
|---|---|
| getDocumentLevelFontSources () | Specifies sources for external fonts to be used by the presentation. These fonts are available to the presentation throughout its lifetime and are not shared with other presentations |
Returns: FontSources
getInterruptionToken
| Name | Description |
|---|---|
| getInterruptionToken () | The token to monitor for interruption requests. This token manages the whole IPresentation instance lifetime. Any long-running operation, such as loading or saving of presentation, will be interrupted via calling of the InterruptionTokenSource#interrupt method of the InterruptionTokenSource. |
Returns: InterruptionToken
getLoadFormat
| Name | Description |
|---|---|
| getLoadFormat () | Returns or sets format of a presentation to load. Read/write LoadFormat. |
Returns: int
getOnlyLoadDocumentProperties
| Name | Description |
|---|---|
| getOnlyLoadDocumentProperties () | This property makes sense, if presentation file is password protected. Value of true means that only document properties must be loaded from an encrypted presentation file and password must be ignored. Value of false means that entire encrypted presentation must be loaded with use of right password. If presentation isn’t encrypted then property value is always ignored. If document properties of an encrypted file aren’t public and property value is true then document properties cannot be loaded and exception will be thrown. Read/write boolean. |
Returns: boolean
getPassword
| Name | Description |
|---|---|
| getPassword () | Gets or sets the password. Read/write String. Value: The password. |
Returns: String
getResourceLoadingCallback
| Name | Description |
|---|---|
| getResourceLoadingCallback () | Returns or sets callback interface which manages external resources loading. Read/write IResourceLoadingCallback. |
Returns: SvgResourceResolver, ResourceLoadingAdapter
getSpreadsheetOptions
| Name | Description |
|---|---|
| getSpreadsheetOptions () | Gets options for spreadsheets. For example, these options affect calculating formulas for charts. |
Returns: SpreadsheetOptions
getWarningCallback
| Name | Description |
|---|---|
| getWarningCallback () | Returns or sets an object which receives warnings and decides whether loading process will continue or will be aborted. Read/write IWarningCallback. |
Returns: IWarningCallback
setBlobManagementOptions
| Name | Description |
|---|---|
| setBlobManagementOptions (BlobManagementOptions) | Represents the options which can be used to manage Binary Large Objects (BLOBs) handling behavior, such as using of temporary files or max BLOBs bytes in memory. These options intended to set up the best performance/memory consumption ratio for a perticular environment or requirements. A Binary Large Object (BLOB) is a binary data stored as a single entity - i.e. BLOB can be an audio, video or presentation itself. |
Returns: void
setDefaultAsianFont
| Name | Description |
|---|---|
| setDefaultAsianFont (String) | Returns or sets Asian font used in case source font is not found. Read/write String. |
Returns: void
setDefaultRegularFont
| Name | Description |
|---|---|
| setDefaultRegularFont (String) | Returns or sets Regular font used in case source font is not found. Read/write String. |
Returns: void
setDefaultSymbolFont
| Name | Description |
|---|---|
| setDefaultSymbolFont (String) | Returns or sets Symbol font used in case source font is not found. Read/write String. |
Returns: void
setDefaultTextLanguage
| Name | Description |
|---|---|
| setDefaultTextLanguage (String) | Returns or sets the default language for presentation text. Read/write String. |
Returns: void
setDocumentLevelFontSources
| Name | Description |
|---|---|
| setDocumentLevelFontSources (FontSources) | Specifies sources for external fonts to be used by the presentation. These fonts are available to the presentation throughout its lifetime and are not shared with other presentations |
Returns: void
setInterruptionToken
| Name | Description |
|---|---|
| setInterruptionToken (InterruptionToken) | The token to monitor for interruption requests. This token manages the whole IPresentation instance lifetime. Any long-running operation, such as loading or saving of presentation, will be interrupted via calling of the InterruptionTokenSource#interrupt method of the InterruptionTokenSource. |
Returns: void
setLoadFormat
| Name | Description |
|---|---|
| setLoadFormat (int) | Returns or sets format of a presentation to load. Read/write LoadFormat. |
Returns: void
setOnlyLoadDocumentProperties
| Name | Description |
|---|---|
| setOnlyLoadDocumentProperties (boolean) | This property makes sense, if presentation file is password protected. Value of true means that only document properties must be loaded from an encrypted presentation file and password must be ignored. Value of false means that entire encrypted presentation must be loaded with use of right password. If presentation isn’t encrypted then property value is always ignored. If document properties of an encrypted file aren’t public and property value is true then document properties cannot be loaded and exception will be thrown. Read/write boolean. |
Returns: void
setPassword
| Name | Description |
|---|---|
| setPassword (String) | Gets or sets the password. Read/write String. Value: The password. |
Returns: void
setResourceLoadingCallback
| Name | Description |
|---|---|
| setResourceLoadingCallback (IResourceLoadingCallback) | Returns or sets callback interface which manages external resources loading. Read/write IResourceLoadingCallback. |
Returns: void
setSpreadsheetOptions
| Name | Description |
|---|---|
| setSpreadsheetOptions (SpreadsheetOptions) | Gets options for spreadsheets. For example, these options affect calculating formulas for charts. |
Returns: void
setWarningCallback
| Name | Description |
|---|---|
| setWarningCallback (IWarningCallback) | Returns or sets an object which receives warnings and decides whether loading process will continue or will be aborted. Read/write IWarningCallback. |
Returns: void