com.aspose.slides
Class OleObjectFrame

java.lang.Object
  extended by com.aspose.slides.Shape
      extended by com.aspose.slides.PictureFrame
          extended by com.aspose.slides.OleObjectFrame

public final class OleObjectFrame
extends PictureFrame

Represents an OleObjectFrame shape.


Method Summary
 int getFollowColorScheme()
           Determines how an OLE object follows the color scheme.
 java.lang.String getLinkPathLong()
           Returns full path to the linked file.
 java.lang.String getLinkPathRelative()
           Returns relative path to the linked file if set.
 java.lang.String getLinkPathShort()
           Returns full path to the linked file.
 java.lang.String getObjectClassName()
           Returns the class name of an object.
 byte[] getObjectData()
           Returns or sets embedded object as byte array.
 boolean getObjectIsIcon()
          Deprecated. 
 boolean getObjectIsLink()
          Deprecated. 
 java.lang.String getObjectName()
           Returns the name of an object.
 java.lang.String getObjectProgId()
           Returns the ProgID of an object.
 int getObjectType()
           Returns or sets the type of an object.
 boolean isObjectIcon()
           <b>True</b> if only icon of the object is visible.
 void isObjectIcon(boolean value)
           
 boolean isObjectLink()
           <b>True</b> if the object is link and not embedded to the presentation.
 void setFollowColorScheme(int value)
           
 void setObjectClassName(java.lang.String value)
           
 void setObjectData(byte[] value)
           
 void setObjectIsIcon(boolean value)
          Deprecated. 
 void setObjectLink(java.lang.String relativePath, java.lang.String longFullPath, java.lang.String shortFullPath)
           Sets linked object paths.
 void setObjectLink(java.lang.String programId, java.util.UUID classId, java.lang.String relativePath, java.lang.String longFullPath, java.lang.String shortFullPath)
           
 void setObjectName(java.lang.String value)
           
 void setObjectProgId(java.lang.String value)
           
 void setObjectType(int value)
           
 
Methods inherited from class com.aspose.slides.PictureFrame
addTextFrame, getBrightness, getColorType, getContrast, getCropBottom, getCropLeft, getCropRight, getCropTop, getPictureFileName, getPictureId, getPictureLinked, getRecolor, getTransparentColor, isPictureLinked, serialize, setBrightness, setColorType, setContrast, setCropBottom, setCropLeft, setCropRight, setCropTop, setPictureFileName, setPictureId, setTransparentColor
 
Methods inherited from class com.aspose.slides.Shape
addLink, clearLink, createShapeElements, createShapeElements, getAlternativeText, getAnimationSettings, getConnectionSites, getConnectionSitesRaw, getFillFormat, getFlipH, getFlipHorizontal, getFlipV, getFlipVertical, getHeight, getHidden, getLineFormat, getLink, getMasterShapeId, getName, getParent, getParentSlide, getPlaceholder, getProtection, getRotation, getShadowFormat, getShapeId, getShapeRectangle, getTags, getTextFrame, getThreeDFormat, getWidth, getX, getY, getZOrderPosition, hasExternalData, isMasterTextHolder, isTextHolder, setAlternativeText, setFlipH, setFlipHorizontal, setFlipV, setFlipVertical, setHeight, setHidden, setName, setProtection, setRotation, setWidth, setX, setY, zOrder
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getObjectType

public int getObjectType()

Returns or sets the type of an object. Read/write OleObjectType.


setObjectType

public void setObjectType(int value)

getObjectName

public java.lang.String getObjectName()

Returns the name of an object. Read-only string.


setObjectName

public void setObjectName(java.lang.String value)

getObjectClassName

public java.lang.String getObjectClassName()

Returns the class name of an object. Read-only string.


setObjectClassName

public void setObjectClassName(java.lang.String value)

getObjectProgId

public java.lang.String getObjectProgId()

Returns the ProgID of an object. Read-only string.


setObjectProgId

public void setObjectProgId(java.lang.String value)

getObjectData

public byte[] getObjectData()

Returns or sets embedded object as byte array. Read/write byte[].

Throws:
PptReadException - In case OleObjectFrame is an Ole1 native object with unsupported format.

setObjectData

public void setObjectData(byte[] value)

isObjectIcon

public boolean isObjectIcon()

<b>True</b> if only icon of the object is visible. Read/write bool.


isObjectIcon

public void isObjectIcon(boolean value)

getObjectIsIcon

@Deprecated
public boolean getObjectIsIcon()
Deprecated. 

<b>True</b> if only icon of the object is visible. Read/write bool.


setObjectIsIcon

@Deprecated
public void setObjectIsIcon(boolean value)
Deprecated. 


isObjectLink

public boolean isObjectLink()

<b>True</b> if the object is link and not embedded to the presentation. Read-only bool.


getObjectIsLink

@Deprecated
public boolean getObjectIsLink()
Deprecated. 

<b>True</b> if the object is link and not embedded to the presentation. Read-only bool.


getLinkPathShort

public java.lang.String getLinkPathShort()

Returns full path to the linked file. File name will be in short format. Read-only string.


getLinkPathLong

public java.lang.String getLinkPathLong()

Returns full path to the linked file. Long file name will be used. Read-only string.


getLinkPathRelative

public java.lang.String getLinkPathRelative()

Returns relative path to the linked file if set. If this path is present and points to a file, other paths will be ignored. Read-only string.


setObjectLink

public void setObjectLink(java.lang.String relativePath,
                          java.lang.String longFullPath,
                          java.lang.String shortFullPath)

Sets linked object paths. It is not necessary to set all of these paths, if some of value is null or empty string, this path will be left empty. At least one of paths should be nonempty.

Parameters:
relativePath - Relative path. If this path is present and points to an existing file, other paths will be ignored.
longFullPath - Absolute path.
shortFullPath - Absolute path using DOS (8.3) name format

setObjectLink

public void setObjectLink(java.lang.String programId,
                          java.util.UUID classId,
                          java.lang.String relativePath,
                          java.lang.String longFullPath,
                          java.lang.String shortFullPath)

getFollowColorScheme

public int getFollowColorScheme()

Determines how an OLE object follows the color scheme. Read/write OleFollowColorScheme.


setFollowColorScheme

public void setFollowColorScheme(int value)