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. | ||
java.lang.String | getIconCaption() | |
Gets icon caption of OLE object.
In case of OLE object is not embedded as icon or caption couldn't be retrieved returns empty string. |
||
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() | |
Gets the draw aspect of the OLE object. 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. | ||
java.lang.String | getSuggestedExtension() | |
Gets the file extension suggested for the current embedded object if you want to save it into a file. |
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 the embedded object into the specified stream. | ||
void | save(java.lang.String fileName) | |
Saves the data of the embedded object into a file with the specified name. |
Property Getters/Setters Detail |
---|
getAutoUpdate/setAutoUpdate | |
public boolean getAutoUpdate() / public void setAutoUpdate(boolean value) |
The default value is false.
getClsid | |
public java.util.UUID getClsid() |
getIconCaption | |
public java.lang.String getIconCaption() |
In case of OLE object is not embedded as icon or caption couldn't be retrieved returns empty string.
isLink | |
public boolean isLink() |
isLocked/isLocked | |
public boolean isLocked() / public void isLocked(boolean value) |
The default value is false.
getOleIcon | |
public boolean getOleIcon() |
Aspose.Words does not allow to set this property to avoid confusion. If you were able to change the draw aspect in Aspose.Words, Microsoft Word would still display the OLE object in its original draw aspect until you edit or update the OLE object in Microsoft Word.
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.
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
getSuggestedExtension | |
public java.lang.String getSuggestedExtension() |
Method Detail |
---|
getOleEntry | |
public System.IO.MemoryStream getOleEntry(java.lang.String oleEntryName) |
oleEntryName
- Case-sensitive name of the OLE data stream.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 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.