java.lang.Objectcom.aspose.words.OleFormat
public class OleFormat
Use the
Property Getters/Setters Summary | ||
---|---|---|
boolean | getAutoUpdate() | |
void | setAutoUpdate(boolean value) | |
Specifies whether the link to the OLE object is automatically updated or not in Microsoft Word. | ||
java.util.UUID | getClsid() | |
Gets the CLSID of the OLE object. | ||
boolean | isLink() | |
Returns true if the OLE object is linked (when |
||
boolean | isLocked() | |
void | isLocked(boolean value) | |
Specifies whether the link to the OLE object is locked from updates. | ||
boolean | getOleIcon() | |
void | setOleIcon(boolean value) | |
When true, the OLE object is displayed as an icon. When false, the OLE object is displayed as content. | ||
java.lang.String | getProgId() | |
void | setProgId(java.lang.String value) | |
Gets or sets the ProgID of the OLE object. | ||
java.lang.String | getSourceFullName() | |
void | setSourceFullName(java.lang.String value) | |
Gets or sets the path and name of the source file for the linked OLE object. | ||
java.lang.String | getSourceItem() | |
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. |
Method Summary | ||
---|---|---|
System.IO.MemoryStream | getOleEntry(java.lang.String oleEntryName) | |
Gets a named stream from OLE object data. | ||
void | save(java.io.OutputStream stream) | |
Saves the data of an embedded OLE object into the specified stream. | ||
void | save(java.lang.String fileName) | |
Saves the data of an embedded OLE object into the file with the specified name. |
Property Getters/Setters Detail |
---|
getProgId/setProgId | |
public java.lang.String getProgId() / public void setProgId(java.lang.String value) |
The ProgID property is not always present in Microsoft Word documents and cannot be relied upon.
Cannot be null.
The default value is an empty string.
isLink | |
public boolean isLink() |
getSourceFullName/setSourceFullName | |
public java.lang.String getSourceFullName() / public void setSourceFullName(java.lang.String value) |
The default value is an empty string.
If
getSourceItem/setSourceItem | |
public java.lang.String getSourceItem() / public void setSourceItem(java.lang.String value) |
The default value is an empty string.
For example, if the source file is a Microsoft Excel workbook, the
getAutoUpdate/setAutoUpdate | |
public boolean getAutoUpdate() / public void setAutoUpdate(boolean value) |
The default value is false.
getOleIcon/setOleIcon | |
public boolean getOleIcon() / public void setOleIcon(boolean value) |
isLocked/isLocked | |
public boolean isLocked() / public void isLocked(boolean value) |
The default value is false.
getClsid | |
public java.util.UUID getClsid() |
Method Detail |
---|
save | |
public void save(java.io.OutputStream stream) throws java.lang.Exception |
It is the responsibility of the caller to dispose the stream.
stream
- Where to save the OLE object data.save | |
public void save(java.lang.String fileName) throws java.lang.Exception |
fileName
- Name of the file to save the OLE object data.getOleEntry | |
public System.IO.MemoryStream getOleEntry(java.lang.String oleEntryName) throws java.lang.Exception |
oleEntryName
- Name of the OLE data stream.