OleFormat
Overview
OleFormat is a class in Aspose.Words FOSS for Java.
Provides access to the data of an OLE object or ActiveX control.
Edition status of its 34 listed members (a property and its accessor methods are listed separately, overloads once): 34 not yet exercised by a verified example.
This class declares 22 methods for OleFormat objects in Java programs.
Available methods include: getAutoUpdate, getClsid, getIconCaption, getOleControl, getOleEntry, getOleIcon, getOlePackage, getProgId, getRawData, getSourceFullName, getSourceItem, getSuggestedExtension, and 8 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: autoUpdate, clsid, iconCaption, link, locked, oleControl, and 8 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
rawData | byte[] | Read | Gets OLE object raw data. |
iconCaption | String | Read | Gets icon caption of OLE object. |
suggestedExtension | String | Read | Gets the file extension suggested for the current embedded object if you want to save it into a file. |
suggestedFileName | String | Read | Gets the file name suggested for the current embedded object if you want to save it into a file. |
progId | String | Read/Write | Gets or sets the ProgID of the OLE object. |
link | boolean | Read | Returns true if the OLE object is linked (when SourceFullName is specified). |
sourceFullName | String | Read/Write | Gets or sets the path and name of the source file for the linked OLE object. |
sourceItem | String | Read/Write | Gets or sets a string that is used to identify the portion of the source file that is being linked. |
autoUpdate | boolean | Read/Write | Specifies whether the link to the OLE object is automatically updated or not in Microsoft Word. |
oleIcon | boolean | Read | Gets the draw aspect of the OLE object. |
locked | boolean | Read/Write | Specifies whether the link to the OLE object is locked from updates. |
clsid | java.util.UUID | Read | Gets the clsid. |
olePackage | OlePackage | Read | Provide access to OlePackage if OLE object is an OLE Package. |
oleControl | OleControl | Read | Gets OleControl objects if this OLE object is an ActiveX control. |
Methods
| Signature | Description |
|---|---|
save(stream: java.io.OutputStream) | Calls save(stream) on this OleFormat instance. |
save(fileName: String) | Saves the data of the embedded object into a file with the specified name. |
getOleEntry(oleEntryName: String) → byte[] | Calls getOleEntry(oleEntryName) on this OleFormat instance. |
getRawData() → byte[] | Gets OLE object raw data. |
getIconCaption() → String | Gets icon caption of OLE object. |
getSuggestedExtension() → String | Gets the file extension suggested for the current embedded object if you want to save it into a file. |
getSuggestedFileName() → String | Gets the file name suggested for the current embedded object if you want to save it into a file. |
getProgId() → String | Gets or sets the ProgID of the OLE object. |
setProgId(value: String) | Sets the prog id value. |
isLink() → boolean | Returns true if the OLE object is linked (when SourceFullName is specified). |
getSourceFullName() → String | Gets or sets the path and name of the source file for the linked OLE object. |
setSourceFullName(value: String) | Sets the source full name value. |
getSourceItem() → String | Gets or sets a string that is used to identify the portion of the source file that is being linked. |
setSourceItem(value: String) | Sets the source item value. |
getAutoUpdate() → boolean | Specifies whether the link to the OLE object is automatically updated or not in Microsoft Word. |
setAutoUpdate(value: boolean) | Sets the auto update value. |
getOleIcon() → boolean | Gets the draw aspect of the OLE object. |
isLocked() → boolean | Specifies whether the link to the OLE object is locked from updates. |
isLocked(value: boolean) | Calls isLocked(value) on this OleFormat instance. |
getClsid() → java.util.UUID | Returns the clsid. |
getOlePackage() → OlePackage | Provide access to OlePackage if OLE object is an OLE Package. |
getOleControl() → OleControl | Gets OleControl objects if this OLE object is an ActiveX control. |