com.aspose.slides

Class OleObjectFrame

java.lang.Object

com.aspose.slides.Shape

com.aspose.slides.GraphicalObject

com.aspose.slides.OleObjectFrame

All Implemented Interfaces:

IGraphicalObject, IHyperlinkContainer, IOleObjectFrame, IPresentationComponent, IShape, ISlideComponent

public class OleObjectFrame
extends GraphicalObject
implements IOleObjectFrame

Represents an OLE object on a slide.

 The following example shows how to accessing OLE Object frames.
 
 // Loads the PPTX to a presentation object
 Presentation pres = new Presentation("AccessingOLEObjectFrame.pptx");
 try {
     // Accesses the first slide
     ISlide sld = pres.getSlides().get_Item(0);
     // Casts the shape to OleObjectFrame
     OleObjectFrame oleObjectFrame = (OleObjectFrame) sld.getShapes().get_Item(0);
     // Reads the OLE Object and writes it to disk
     if (oleObjectFrame != null) {
         // Gets embedded file data
         byte[] data = oleObjectFrame.getEmbeddedData().getEmbeddedFileData();
         // Gets embedded file extention
         String fileExtension = oleObjectFrame.getEmbeddedData().getEmbeddedFileExtension();
         // Creates a path to save the extracted file
         String extractedPath = "excelFromOLE_out" + fileExtension;
         // Saves extracted data
         Files.write(Paths.get(extractedPath), data);
     }
 } catch(IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Method Summary

Modifier and Type	Method and Description
IOleEmbeddedDataInfo	getEmbeddedData() Gets or sets information about OLE embedded data.
java.lang.String	getEmbeddedFileLabel() Returns the file name of embedded OLE object
java.lang.String	getEmbeddedFileName() Returns the path of embedded OLE object
java.lang.String	getLinkFileName() Returns the full path to a linked file.
java.lang.String	getLinkPathLong() Returns the full path to a linked file.
java.lang.String	getLinkPathRelative() Returns the relative path to a linked file if present, otherwise returns an empty string.
java.lang.String	getObjectName() Returns or sets the name of an object.
java.lang.String	getObjectProgId() Returns the ProgID of an object.
IPictureFillFormat	getSubstitutePictureFormat() Returns OleObject image fill properties object.
java.lang.String	getSubstitutePictureTitle() Returns or sets the title for OleObject icon.
boolean	getUpdateAutomatic() Determines if the linked embedded object is automatically updated when the presentation is opened or printed.
boolean	isObjectIcon() Determines whether an object is visible as icon.
boolean	isObjectLink() Determines whether an object is linked to external file.
void	setEmbeddedData(IOleEmbeddedDataInfo embeddedData) Sets information about OLE embedded data.
void	setLinkPathLong(java.lang.String value) Returns the full path to a linked file.
void	setObjectIcon(boolean value) Determines whether an object is visible as icon.
void	setObjectName(java.lang.String value) Returns or sets the name of an object.
void	setObjectProgId(java.lang.String value) Returns the ProgID of an object.
void	setSubstitutePictureTitle(java.lang.String value) Returns or sets the title for OleObject icon.
void	setUpdateAutomatic(boolean value) Determines if the linked embedded object is automatically updated when the presentation is opened or printed.

Methods inherited from class com.aspose.slides.GraphicalObject

getGraphicalObjectLock

Methods inherited from class com.aspose.slides.Shape

addPlaceholder, getAlternativeText, getAlternativeTextTitle, getBasePlaceholder, getBlackWhiteMode, getConnectionSiteCount, getCustomData, getEffectFormat, getFillFormat, getFrame, getHeight, getHidden, getHyperlinkClick, getHyperlinkManager, getHyperlinkMouseOver, getImage, getImage, getLineFormat, getName, getOfficeInteropShapeId, getParent_Immediate, getParentGroup, getPlaceholder, getPresentation, getRawFrame, getRotation, getShapeLock, getSlide, getThreeDFormat, getThumbnail, getThumbnail, getUniqueId, getWidth, getX, getY, getZOrderPosition, isDecorative, isGrouped, isTextHolder, removePlaceholder, setAlternativeText, setAlternativeTextTitle, setBlackWhiteMode, setDecorative, setFrame, setHeight, setHidden, setHyperlinkClick, setHyperlinkMouseOver, setName, setRawFrame, setRotation, setWidth, setX, setY, writeAsSvg, writeAsSvg

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspose.slides.IGraphicalObject

getGraphicalObjectLock

Methods inherited from interface com.aspose.slides.IShape

addPlaceholder, getAlternativeText, getAlternativeTextTitle, getBasePlaceholder, getBlackWhiteMode, getConnectionSiteCount, getCustomData, getEffectFormat, getFillFormat, getFrame, getHeight, getHidden, getImage, getImage, getLineFormat, getName, getOfficeInteropShapeId, getParentGroup, getPlaceholder, getRawFrame, getRotation, getShapeLock, getThreeDFormat, getThumbnail, getThumbnail, getUniqueId, getWidth, getX, getY, getZOrderPosition, isDecorative, isGrouped, isTextHolder, removePlaceholder, setAlternativeText, setAlternativeTextTitle, setBlackWhiteMode, setDecorative, setFrame, setHeight, setHidden, setName, setRawFrame, setRotation, setWidth, setX, setY, writeAsSvg, writeAsSvg

Methods inherited from interface com.aspose.slides.ISlideComponent

getSlide

Methods inherited from interface com.aspose.slides.IPresentationComponent

getPresentation

Methods inherited from interface com.aspose.slides.IHyperlinkContainer

getHyperlinkClick, getHyperlinkManager, getHyperlinkMouseOver, setHyperlinkClick, setHyperlinkMouseOver

Method Detail

getSubstitutePictureFormat

public final IPictureFillFormat getSubstitutePictureFormat()

Returns OleObject image fill properties object. Read-only IPictureFillFormat.

Specified by:

getSubstitutePictureFormat in interface IOleObjectFrame

getSubstitutePictureTitle

public final java.lang.String getSubstitutePictureTitle()

Returns or sets the title for OleObject icon. Read/write String.

When IsObjectIcon == false this value is ignored. The string can be truncated according to the size of the Ole icon.

Specified by:

getSubstitutePictureTitle in interface IOleObjectFrame

setSubstitutePictureTitle

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

Returns or sets the title for OleObject icon. Read/write String.

When IsObjectIcon == false this value is ignored. The string can be truncated according to the size of the Ole icon.

Specified by:

setSubstitutePictureTitle in interface IOleObjectFrame

getObjectName

public final java.lang.String getObjectName()

Returns or sets the name of an object. Read/write String.

Specified by:

getObjectName in interface IOleObjectFrame

setObjectName

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

Returns or sets the name of an object. Read/write String.

Specified by:

setObjectName in interface IOleObjectFrame

getObjectProgId

public final java.lang.String getObjectProgId()

Returns the ProgID of an object. Read only String.

Specified by:

getObjectProgId in interface IOleObjectFrame

setObjectProgId

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

Returns the ProgID of an object. Read only String.

Specified by:

setObjectProgId in interface IOleObjectFrame

getLinkFileName

public final java.lang.String getLinkFileName()

Returns the full path to a linked file. Short file name will be used. Read-only String.

Specified by:

getLinkFileName in interface IOleObjectFrame

getLinkPathLong

public final java.lang.String getLinkPathLong()

Returns the full path to a linked file. Long file name will be used. Read/write String.

Specified by:

getLinkPathLong in interface IOleObjectFrame

setLinkPathLong

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

Returns the full path to a linked file. Long file name will be used. Read/write String.

Specified by:

setLinkPathLong in interface IOleObjectFrame

getLinkPathRelative

public final java.lang.String getLinkPathRelative()

Returns the relative path to a linked file if present, otherwise returns an empty string. Readonly String.

  
 Presentation presentation = new Presentation("demo.ppt");
 try {
     IOleObjectFrame oleFrame = (IOleObjectFrame)presentation.getSlides().get_Item(0).getShapes().get_Item(0);
     if (oleFrame != null)
     {
         System.out.println("The relative path: " + oleFrame.getLinkPathRelative());
     }
 } finally {
     if (presentation != null) presentation.dispose();
 }
  
  

In the Ppt presentations, some Ole object links may have a relative representation.

Specified by:

getLinkPathRelative in interface IOleObjectFrame

getEmbeddedFileLabel

public final java.lang.String getEmbeddedFileLabel()

Returns the file name of embedded OLE object

Specified by:

getEmbeddedFileLabel in interface IOleObjectFrame

getEmbeddedFileName

public final java.lang.String getEmbeddedFileName()

Returns the path of embedded OLE object

Specified by:

getEmbeddedFileName in interface IOleObjectFrame

getEmbeddedData

public final IOleEmbeddedDataInfo getEmbeddedData()

Gets or sets information about OLE embedded data. Read/write IOleEmbeddedDataInfo.

Specified by:

getEmbeddedData in interface IOleObjectFrame

setEmbeddedData

public final void setEmbeddedData(IOleEmbeddedDataInfo embeddedData)

Sets information about OLE embedded data.

 
 Presentation pres = new Presentation("SomePresentation.pptx");
 try {
     OleObjectFrame oof = (OleObjectFrame) pres.getSlides().get_Item(0).getShapes().get_Item(0);
     if (oof != null)
     {
         IOleEmbeddedDataInfo newData = new OleEmbeddedDataInfo(Files.readAllBytes(Paths.get("Picture.png")), "png");
         oof.setEmbeddedData(newData);
     }
 } catch (IOException e) {
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

setEmbeddedData in interface IOleObjectFrame

Parameters:

embeddedData - Embedded data IOleEmbeddedDataInfo

This method changes the properties of the object to reflect the new data and sets the IsObjectLink flag to false, indicating that the OLE object is embedded.

Throws:

com.aspose.ms.System.ArgumentNullException - When embeddedData parameter is null.

isObjectIcon

public final boolean isObjectIcon()

Determines whether an object is visible as icon. Read/write boolean.

Specified by:

isObjectIcon in interface IOleObjectFrame

setObjectIcon

public final void setObjectIcon(boolean value)

Determines whether an object is visible as icon. Read/write boolean.

Specified by:

setObjectIcon in interface IOleObjectFrame

isObjectLink

public final boolean isObjectLink()

Determines whether an object is linked to external file. Read-only boolean.

Specified by:

isObjectLink in interface IOleObjectFrame

getUpdateAutomatic

public final boolean getUpdateAutomatic()

Determines if the linked embedded object is automatically updated when the presentation is opened or printed. Read/write boolean.

Specified by:

getUpdateAutomatic in interface IOleObjectFrame

setUpdateAutomatic

public final void setUpdateAutomatic(boolean value)

Determines if the linked embedded object is automatically updated when the presentation is opened or printed. Read/write boolean.

Specified by:

setUpdateAutomatic in interface IOleObjectFrame