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
All Implemented Interfaces:
IPictureFrame, IShape, IShapeFormat

public final class OleObjectFrame
extends PictureFrame

Represents the OleObjectFrame shape.


Field Summary
 
Fields inherited from class com.aspose.slides.Shape
defaultConnectionPoints, emptyConnectionPoints, emptyShape, m_anchor, m_animationSettings, m_fillFormat, m_frame, m_lineFormat, m_link, m_nFSTVersion, m_options, m_parent, m_shadowFormat, m_shapesParent, m_tags, m_TextFrame, m_version
 
Method Summary
 java.lang.String getLinkPathLong()
          Returns full path to the linked file.
 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 the embedded object as byte array.
 java.lang.String getObjectName()
          Returns the name of an object.
 java.lang.String getObjectProgId()
          Returns the ProgID of an object.
 int getObjectType()
          Returns the type of an object.
 boolean isObjectIcon()
          Determines whether the object is visible as icon only.
 boolean isObjectLink()
          Determines whether the object is link and not embedded to a presentation.
 void setObjectClassName(java.lang.String value)
          Sets the class name of an object.
 void setObjectData(byte[] value)
          Sets embedded object as byte array.
 void setObjectIcon(boolean value)
          Sets whether the object is visible as icon only.
 void setObjectName(java.lang.String value)
          Sets the name of an object.
 void setObjectProgId(java.lang.String value)
          Sets the ProgID of an object.
 void setObjectType(int type)
          Sets the type of an object.
 
Methods inherited from class com.aspose.slides.PictureFrame
addTextFrame, getBrightness, getColorType, getContrast, getCropBottom, getCropLeft, getCropRight, getCropTop, getPictureFileName, getPictureId, 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, getAnchor, getAnimationSettings, getConnectionSites, getConnectionSitesRaw, getFillFormat, getFrame, getgeoBottom, getgeoRight, getHeight, getLineFormat, getLink, getMasterShapeId, getName, getOptions, getParent, getPlaceholder, getRotation, getRotation0_360, getShadowFormat, getShapeId, getShapeRectangle, getTags, getTextFrame, getThreeDFormat, getWidth, getX, getY, getZOrderPosition, hasExternalData, isFlipH, isFlipV, isHidden, isMasterTextHolder, isTextHolder, setAlternativeText, setFlipH, setFlipV, setHeight, setHidden, setName, setRotation, setWidth, setX, setY, shouldDraw, zOrder
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getObjectType

public int getObjectType()
Returns the type of an object.

Returns:
The object type. See OleObjectType.

setObjectType

public void setObjectType(int type)
Sets the type of an object.

Parameters:
type - the new type of an object.

getObjectName

public java.lang.String getObjectName()
Returns the name of an object.

Returns:
the name of an object. See String.

setObjectName

public void setObjectName(java.lang.String value)
Sets the name of an object.

Parameters:
value - the name of an object.

getObjectClassName

public java.lang.String getObjectClassName()
Returns the class name of an object.

Returns:
the class name of an object. See String.

setObjectClassName

public void setObjectClassName(java.lang.String value)
Sets the class name of an object.

Parameters:
value - the class name of an object.

getObjectProgId

public java.lang.String getObjectProgId()
Returns the ProgID of an object.

Returns:
the ProgID of an object. See String.

setObjectProgId

public void setObjectProgId(java.lang.String value)
Sets the ProgID of an object.

Parameters:
value - the ProgID of an object.

getObjectData

public byte[] getObjectData()
                     throws PptReadException
Returns the embedded object as byte array.

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

setObjectData

public void setObjectData(byte[] value)
                   throws PptException
Sets embedded object as byte array.

Parameters:
value - byte array.
Throws:
PptException

isObjectIcon

public boolean isObjectIcon()
Determines whether the object is visible as icon only.

Returns:
true if only icon of the object is visible.

setObjectIcon

public void setObjectIcon(boolean value)
Sets whether the object is visible as icon only.

Parameters:
value - true if only icon of the object is visible.

isObjectLink

public boolean isObjectLink()
Determines whether the object is link and not embedded to a presentation.

Returns:
true if object is link and not embedded to a presentation.

getLinkPathShort

public java.lang.String getLinkPathShort()
Returns full path to the linked file. File name will be in short format.

Returns:
full path to the linked file.

getLinkPathLong

public java.lang.String getLinkPathLong()
Returns full path to the linked file. Long file name will be used.

Returns:
full path to the linked file.