ASPOSE home

com.aspose.words
Class OleFormat

java.lang.Object
    extended by com.aspose.words.OleFormat

public class OleFormat
extends java.lang.Object

Provides access to the data of an OLE object or ActiveX control.

Use the Shape.OleFormat property to access the data of an OLE object. You do not create instances of the OleFormat class directly.

See Also:
Shape.OleFormat

Property Getters/Setters Summary
booleangetAutoUpdate()
voidsetAutoUpdate(boolean value)
           Specifies whether the link to the OLE object is automatically updated or not in Microsoft Word.
java.util.UUIDgetClsid()
           Gets the CLSID of the OLE object.
booleanisLink()
           Returns true if the OLE object is linked (when SourceFullName is specified).
java.lang.StringgetProgId()
voidsetProgId(java.lang.String value)
           Gets or sets the ProgID of the OLE object.
java.lang.StringgetSourceFullName()
voidsetSourceFullName(java.lang.String value)
           Gets or sets the path and name of the source file for the linked OLE object.
java.lang.StringgetSourceItem()
voidsetSourceItem(java.lang.String value)
           Gets or sets a string that is used to identify the portion of the source file that is being linked.
 
Method Summary
voidsave(java.io.OutputStream stream)
           Stores the native data of the OLE object into the specified stream in the Structured Storage format.
 

Property Getters/Setters Detail

getProgId/setProgId

public java.lang.String getProgId()

public void setProgId(java.lang.String value)
Gets or sets the ProgID of the OLE object.

The default value is an empty string.


isLink

public boolean isLink()
Returns true if the OLE object is linked (when SourceFullName is specified).

getSourceFullName/setSourceFullName

public java.lang.String getSourceFullName()

public void setSourceFullName(java.lang.String value)
Gets or sets the path and name of the source file for the linked OLE object.

The default value is an empty string.

If SourceFullName is not an empty string, the OLE object is linked.


getSourceItem/setSourceItem

public java.lang.String getSourceItem()

public void setSourceItem(java.lang.String value)
Gets or sets a string that is used to identify the portion of the source file that is being linked.

The default value is an empty string.

For example, if the source file is a Microsoft Excel workbook, the SourceItem property might return "Workbook1!R3C1:R4C2" if the OLE object contains only a few cells from the worksheet.


getAutoUpdate/setAutoUpdate

public boolean getAutoUpdate()

public void setAutoUpdate(boolean value)
Specifies whether the link to the OLE object is automatically updated or not in Microsoft Word.

The default value is false.


getClsid

public java.util.UUID getClsid()
Gets the CLSID of the OLE object.

Method Detail

save

public void save(java.io.OutputStream stream)
         throws java.lang.Exception
Stores the native data of the OLE object into the specified stream in the Structured Storage format.

It is the responsibility of the caller to dispose the stream.

Parameters:
stream - Where to save the OLE object data.

See Also:
          Wiki - the home page for the Aspose.Words Product Documentation that includes Programmer's Guide, Knowledge Base and other articles.
          Aspose.Words Support Forum - our preferred method of support.
          Aspose.Words Team - contact Aspose.Words Team.


ASPOSE home