com.aspose.slides

Class LoadOptions

java.lang.Object

com.aspose.slides.LoadOptions

All Implemented Interfaces:

ILoadOptions

public class LoadOptions
extends java.lang.Object
implements ILoadOptions

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

Constructor Summary

Constructors

Constructor and Description
LoadOptions() Creates new default load options.
LoadOptions(int loadFormat) Creates new load options.

Method Summary

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LoadOptions

public LoadOptions()

Creates new default load options.

LoadOptions

public LoadOptions(int loadFormat)

Creates new load options.

Parameters:

loadFormat - Format of a presentation to load.

Method Detail

getLoadFormat

public final int getLoadFormat()

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

Specified by:

getLoadFormat in interface ILoadOptions

setLoadFormat

public final void setLoadFormat(int value)

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

Specified by:

setLoadFormat in interface ILoadOptions

getDefaultRegularFont

public final java.lang.String getDefaultRegularFont()

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

 The following example shows how to set default fonts for rendering PowerPoint Presentation.
 
 // Use load options to define the default regular and asian fonts
 LoadOptions loadOptions = new LoadOptions(LoadFormat.Auto);
 loadOptions.setDefaultRegularFont("Wingdings");
 loadOptions.setDefaultAsianFont("Wingdings");
 // Load the presentation
 Presentation pres = new Presentation("DefaultFonts.pptx", loadOptions);
 try {
     // Generate slide thumbnail
     BufferedImage slideImage = pres.getSlides().get_Item(0).getThumbnail(1, 1);
     ImageIO.write(slideImage, "PNG", new File("output_out.png"));
     // Generate PDF
     pres.save("output_out.pdf", SaveFormat.Pdf);
     // Generate XPS
     pres.save("output_out.xps", SaveFormat.Xps);
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

getDefaultRegularFont in interface ILoadOptions

setDefaultRegularFont

public final void setDefaultRegularFont(java.lang.String value)

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

 The following example shows how to set default fonts for rendering PowerPoint Presentation.
 
 // Use load options to define the default regular and asian fonts
 LoadOptions loadOptions = new LoadOptions(LoadFormat.Auto);
 loadOptions.setDefaultRegularFont("Wingdings");
 loadOptions.setDefaultAsianFont("Wingdings");
 // Load the presentation
 Presentation pres = new Presentation("DefaultFonts.pptx", loadOptions);
 try {
     // Generate slide thumbnail
     BufferedImage slideImage = pres.getSlides().get_Item(0).getThumbnail(1, 1);
     ImageIO.write(slideImage, "PNG", new File("output_out.png"));
     // Generate PDF
     pres.save("output_out.pdf", SaveFormat.Pdf);
     // Generate XPS
     pres.save("output_out.xps", SaveFormat.Xps);
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

setDefaultRegularFont in interface ILoadOptions

getDefaultSymbolFont

public final java.lang.String getDefaultSymbolFont()

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

Specified by:

getDefaultSymbolFont in interface ILoadOptions

setDefaultSymbolFont

public final void setDefaultSymbolFont(java.lang.String value)

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

Specified by:

setDefaultSymbolFont in interface ILoadOptions

getDefaultAsianFont

public final java.lang.String getDefaultAsianFont()

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

Specified by:

getDefaultAsianFont in interface ILoadOptions

setDefaultAsianFont

public final void setDefaultAsianFont(java.lang.String value)

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

Specified by:

setDefaultAsianFont in interface ILoadOptions

getPassword

public final java.lang.String getPassword()

Gets or sets the password. Read/write String.

 The following sample code shows how to open password protected PowerPoint Presentation.
 
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setPassword("YOUR_PASSWORD");
 Presentation pres = new Presentation("pres.pptx", loadOptions);
 try {
 // work with decrypted presentation
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Value: The password.

Specified by:

getPassword in interface ILoadOptions

setPassword

public final void setPassword(java.lang.String value)

Gets or sets the password. Read/write String.

 The following sample code shows how to open password protected PowerPoint Presentation.
 
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setPassword("YOUR_PASSWORD");
 Presentation pres = new Presentation("pres.pptx", loadOptions);
 try {
 // work with decrypted presentation
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Value: The password.

Specified by:

setPassword in interface ILoadOptions

getOnlyLoadDocumentProperties

public final 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.

Specified by:

getOnlyLoadDocumentProperties in interface ILoadOptions

setOnlyLoadDocumentProperties

public final void setOnlyLoadDocumentProperties(boolean value)

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.

Specified by:

setOnlyLoadDocumentProperties in interface ILoadOptions

getWarningCallback

public final IWarningCallback getWarningCallback()

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

Specified by:

getWarningCallback in interface ILoadOptions

setWarningCallback

public final 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.

Specified by:

setWarningCallback in interface ILoadOptions

getBlobManagementOptions

public final 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 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.

Specified by:

getBlobManagementOptions in interface ILoadOptions

setBlobManagementOptions

public final void 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. 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.

Specified by:

setBlobManagementOptions in interface ILoadOptions

getDocumentLevelFontSources

public final 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

 The following example shows how to specify custom fonts used with PowerPoint Presentation.
 
 byte[] memoryFont1 = Files.readAllBytes(Paths.get("customfonts\\CustomFont1.ttf"));
 byte[] memoryFont2 = Files.readAllBytes(Paths.get("customfonts\\CustomFont2.ttf"));
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.getDocumentLevelFontSources().setFontFolders(new String[] { "assets\\fonts", "global\\fonts" });
 loadOptions.getDocumentLevelFontSources().setMemoryFonts(new byte[][] { memoryFont1, memoryFont2 });
 IPresentation presentation = new Presentation("MyPresentation.pptx", loadOptions);
 try {
 //work with the presentation
 //CustomFont1, CustomFont2 as well as fonts from assets\fonts & global\fonts folders and their subfolders are available to the presentation
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

getDocumentLevelFontSources in interface ILoadOptions

setDocumentLevelFontSources

public final 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

 The following example shows how to specify custom fonts used with PowerPoint Presentation.
 
 byte[] memoryFont1 = Files.readAllBytes(Paths.get("customfonts\\CustomFont1.ttf"));
 byte[] memoryFont2 = Files.readAllBytes(Paths.get("customfonts\\CustomFont2.ttf"));
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.getDocumentLevelFontSources().setFontFolders(new String[] { "assets\\fonts", "global\\fonts" });
 loadOptions.getDocumentLevelFontSources().setMemoryFonts(new byte[][] { memoryFont1, memoryFont2 });
 IPresentation presentation = new Presentation("MyPresentation.pptx", loadOptions);
 try {
 //work with the presentation
 //CustomFont1, CustomFont2 as well as fonts from assets\fonts & global\fonts folders and their subfolders are available to the presentation
 } finally {
     if (presentation != null) presentation.dispose();
 }
 
 

Specified by:

setDocumentLevelFontSources in interface ILoadOptions

getInterruptionToken

public final IInterruptionToken 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.

Specified by:

getInterruptionToken in interface ILoadOptions

setInterruptionToken

public final void setInterruptionToken(IInterruptionToken value)

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.

Specified by:

setInterruptionToken in interface ILoadOptions

getResourceLoadingCallback

public final IResourceLoadingCallback getResourceLoadingCallback()

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

Specified by:

getResourceLoadingCallback in interface ILoadOptions

setResourceLoadingCallback

public final void setResourceLoadingCallback(IResourceLoadingCallback value)

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

Specified by:

setResourceLoadingCallback in interface ILoadOptions

getSpreadsheetOptions

public final ISpreadsheetOptions getSpreadsheetOptions()

Gets options for spreadsheets. For example, these options affect calculating formulas for charts.

Specified by:

getSpreadsheetOptions in interface ILoadOptions

setSpreadsheetOptions

public final void setSpreadsheetOptions(ISpreadsheetOptions value)

Gets options for spreadsheets. For example, these options affect calculating formulas for charts.

Specified by:

setSpreadsheetOptions in interface ILoadOptions

getDefaultTextLanguage

public final java.lang.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();
 }
  
  

Specified by:

getDefaultTextLanguage in interface ILoadOptions

setDefaultTextLanguage

public final void setDefaultTextLanguage(java.lang.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();
 }
  
  

Specified by:

setDefaultTextLanguage in interface ILoadOptions

getDeleteEmbeddedBinaryObjects

public final boolean getDeleteEmbeddedBinaryObjects()

Determines if Aspose.Slides will delete all embedded binary objects while presentation loading.

The types of the embedded binary objects:

Read/write boolean.

 The following example shows how to load the presentation without any embedded binary objects.
 
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setDeleteEmbeddedBinaryObjects(true);
 Presentation pres = new Presentation("pres.ppt", loadOptions);
 try {
     pres.save("output_WithoutBinaryObjects.ppt", SaveFormat.Ppt);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Default is <b>false</b>.

Specified by:

getDeleteEmbeddedBinaryObjects in interface ILoadOptions

setDeleteEmbeddedBinaryObjects

public final void setDeleteEmbeddedBinaryObjects(boolean value)

Determines if Aspose.Slides will delete all embedded binary objects while presentation loading.

The types of the embedded binary objects:

Read/write boolean.

 The following example shows how to load the presentation without any embedded binary objects.
 
 LoadOptions loadOptions = new LoadOptions();
 loadOptions.setDeleteEmbeddedBinaryObjects(true);
 Presentation pres = new Presentation("pres.ppt", loadOptions);
 try {
     pres.save("output_WithoutBinaryObjects.ppt", SaveFormat.Ppt);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Default is <b>false</b>.

Specified by:

setDeleteEmbeddedBinaryObjects in interface ILoadOptions