ILoadOptions

public interface ILoadOptions

Allows to specify additional options (such as format or default font) when loading a presentation.

Methods

Method	Description
getLoadFormat()	Returns or sets format of a presentation to load.
setLoadFormat(int value)	Returns or sets format of a presentation to load.
getDefaultRegularFont()	Returns or sets Regular font used in case source font is not found.
setDefaultRegularFont(String value)	Returns or sets Regular font used in case source font is not found.
getDefaultSymbolFont()	Returns or sets Symbol font used in case source font is not found.
setDefaultSymbolFont(String value)	Returns or sets Symbol font used in case source font is not found.
getDefaultAsianFont()	Returns or sets Asian font used in case source font is not found.
setDefaultAsianFont(String value)	Returns or sets Asian font used in case source font is not found.
getPassword()	Gets or sets the password.
setPassword(String value)	Gets or sets the password.
getOnlyLoadDocumentProperties()	This property makes sense, if presentation file is password protected.
setOnlyLoadDocumentProperties(boolean value)	This property makes sense, if presentation file is password protected.
getWarningCallback()	Returns or sets an object which receives warnings and decides whether loading process will continue or will be aborted.
setWarningCallback(IWarningCallback value)	Returns or sets an object which receives warnings and decides whether loading process will continue or will be aborted.
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.
setBlobManagementOptions(IBlobManagementOptions value)	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.
getDocumentLevelFontSources()	Specifies sources for external fonts to be used by the presentation.
setDocumentLevelFontSources(IFontSources value)	Specifies sources for external fonts to be used by the presentation.
getInterruptionToken()	The token to monitor for interruption requests.
setInterruptionToken(IInterruptionToken value)	The token to monitor for interruption requests.
getResourceLoadingCallback()	Returns or sets callback interface which manages external resources loading.
setResourceLoadingCallback(IResourceLoadingCallback value)	Returns or sets callback interface which manages external resources loading.
getSpreadsheetOptions()	Represents options which can be used to specify additional spreadsheets behavior.
setSpreadsheetOptions(ISpreadsheetOptions value)	Represents options which can be used to specify additional spreadsheets behavior.
getDefaultTextLanguage()	Returns or sets the default language for presentation text.
setDefaultTextLanguage(String value)	Returns or sets the default language for presentation text.

getLoadFormat()

public abstract int getLoadFormat()

Returns or sets format of a presentation to load. Read/write LoadFormat.

Returns: int

setLoadFormat(int value)

public abstract void setLoadFormat(int value)

Returns or sets format of a presentation to load. Read/write LoadFormat.

Parameters:

Parameter	Type	Description
value	int

getDefaultRegularFont()

public abstract String getDefaultRegularFont()

Returns or sets Regular font used in case source font is not found. Read-write String.

Returns: java.lang.String

setDefaultRegularFont(String value)

public abstract void setDefaultRegularFont(String value)

Returns or sets Regular font used in case source font is not found. Read-write String.

Parameters:

Parameter	Type	Description
value	java.lang.String

getDefaultSymbolFont()

public abstract String getDefaultSymbolFont()

Returns or sets Symbol font used in case source font is not found. Read-write String.

Returns: java.lang.String

setDefaultSymbolFont(String value)

public abstract void setDefaultSymbolFont(String value)

Returns or sets Symbol font used in case source font is not found. Read-write String.

Parameters:

Parameter	Type	Description
value	java.lang.String

getDefaultAsianFont()

public abstract String getDefaultAsianFont()

Returns or sets Asian font used in case source font is not found. Read-write String.

Returns: java.lang.String

setDefaultAsianFont(String value)

public abstract void setDefaultAsianFont(String value)

Returns or sets Asian font used in case source font is not found. Read-write String.

Parameters:

Parameter	Type	Description
value	java.lang.String

getPassword()

public abstract String getPassword()

Gets or sets the password. Read-write String.

Value: The password.

Returns: java.lang.String

setPassword(String value)

public abstract void setPassword(String value)

Gets or sets the password. Read-write String.

Value: The password.

Parameters:

Parameter	Type	Description
value	java.lang.String

getOnlyLoadDocumentProperties()

public abstract boolean 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

setOnlyLoadDocumentProperties(boolean value)

public abstract void setOnlyLoadDocumentProperties(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

getWarningCallback()

public abstract IWarningCallback 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

setWarningCallback(IWarningCallback value)

public abstract void setWarningCallback(IWarningCallback value)

Returns or sets an object which receives warnings and decides whether loading process will continue or will be aborted. Read/write IWarningCallback.

Parameters:

Parameter	Type	Description
value	IWarningCallback

getBlobManagementOptions()

public abstract IBlobManagementOptions 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 particular 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: IBlobManagementOptions

setBlobManagementOptions(IBlobManagementOptions value)

public abstract void setBlobManagementOptions(IBlobManagementOptions value)

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.

Parameters:

Parameter	Type	Description
value	IBlobManagementOptions

getDocumentLevelFontSources()

public abstract IFontSources 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: IFontSources

setDocumentLevelFontSources(IFontSources value)

public abstract void setDocumentLevelFontSources(IFontSources value)

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

Parameters:

Parameter	Type	Description
value	IFontSources

getInterruptionToken()

public abstract IInterruptionToken getInterruptionToken()

The token to monitor for interruption requests.

This token manages the whole IPresentation instance lifetime. Any long-running operation, such as presentation loading or saving, will be interrupted via calling of the IInterruptionTokenSource.interrupt method of the IInterruptionTokenSource.

Returns: IInterruptionToken

setInterruptionToken(IInterruptionToken value)

public abstract void setInterruptionToken(IInterruptionToken value)

The token to monitor for interruption requests.

Parameters:

Parameter	Type	Description
value	IInterruptionToken

getResourceLoadingCallback()

public abstract IResourceLoadingCallback getResourceLoadingCallback()

Returns or sets callback interface which manages external resources loading. Read/write IResourceLoadingCallback.

Returns: IResourceLoadingCallback

setResourceLoadingCallback(IResourceLoadingCallback value)

public abstract void setResourceLoadingCallback(IResourceLoadingCallback value)

Returns or sets callback interface which manages external resources loading. Read/write IResourceLoadingCallback.

Parameters:

Parameter	Type	Description
value	IResourceLoadingCallback

getSpreadsheetOptions()

public abstract ISpreadsheetOptions getSpreadsheetOptions()

Represents options which can be used to specify additional spreadsheets behavior.

Returns: ISpreadsheetOptions

setSpreadsheetOptions(ISpreadsheetOptions value)

public abstract void setSpreadsheetOptions(ISpreadsheetOptions value)

Represents options which can be used to specify additional spreadsheets behavior.

Parameters:

Parameter	Type	Description
value	ISpreadsheetOptions

getDefaultTextLanguage()

public abstract String getDefaultTextLanguage()

Returns or sets the default language for presentation text. Read/write String.

Example:
  
 // Use load options to define the default text culture
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setDefaultTextLanguage("en-US");
 Presentation pres = new Presentation(loadOptions);
 try {
     // Add new rectangle shape with text
     IAutoShape shp = pres.getSlides().get_Item(0).getShapes().addAutoShape(ShapeType.Rectangle, 50, 50, 150, 50);
     shp.getTextFrame().setText("New Text");
     // Check the first portion language
     System.out.println(shp.getTextFrame().getParagraphs().get_Item(0).getPortions().get_Item(0).getPortionFormat().getLanguageId());
 } finally {
     if (pres != null) pres.dispose();
 }

Returns: java.lang.String

setDefaultTextLanguage(String value)

public abstract void setDefaultTextLanguage(String value)

Returns or sets the default language for presentation text. Read/write String.

Example:
  
 // Use load options to define the default text culture
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setDefaultTextLanguage("en-US");
 Presentation pres = new Presentation(loadOptions);
 try {
     // Add new rectangle shape with text
     IAutoShape shp = pres.getSlides().get_Item(0).getShapes().addAutoShape(ShapeType.Rectangle, 50, 50, 150, 50);
     shp.getTextFrame().setText("New Text");
     // Check the first portion language
     System.out.println(shp.getTextFrame().getParagraphs().get_Item(0).getPortions().get_Item(0).getPortionFormat().getLanguageId());
 } finally {
     if (pres != null) pres.dispose();
 }

Parameters:

Parameter	Type	Description
value	java.lang.String