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

NameTypeAccessDescription
rawDatabyte[]ReadGets OLE object raw data.
iconCaptionStringReadGets icon caption of OLE object.
suggestedExtensionStringReadGets the file extension suggested for the current embedded object if you want to save it into a file.
suggestedFileNameStringReadGets the file name suggested for the current embedded object if you want to save it into a file.
progIdStringRead/WriteGets or sets the ProgID of the OLE object.
linkbooleanReadReturns true if the OLE object is linked (when SourceFullName is specified).
sourceFullNameStringRead/WriteGets or sets the path and name of the source file for the linked OLE object.
sourceItemStringRead/WriteGets or sets a string that is used to identify the portion of the source file that is being linked.
autoUpdatebooleanRead/WriteSpecifies whether the link to the OLE object is automatically updated or not in Microsoft Word.
oleIconbooleanReadGets the draw aspect of the OLE object.
lockedbooleanRead/WriteSpecifies whether the link to the OLE object is locked from updates.
clsidjava.util.UUIDReadGets the clsid.
olePackageOlePackageReadProvide access to OlePackage if OLE object is an OLE Package.
oleControlOleControlReadGets OleControl objects if this OLE object is an ActiveX control.

Methods

SignatureDescription
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() → StringGets icon caption of OLE object.
getSuggestedExtension() → StringGets the file extension suggested for the current embedded object if you want to save it into a file.
getSuggestedFileName() → StringGets the file name suggested for the current embedded object if you want to save it into a file.
getProgId() → StringGets or sets the ProgID of the OLE object.
setProgId(value: String)Sets the prog id value.
isLink() → booleanReturns true if the OLE object is linked (when SourceFullName is specified).
getSourceFullName() → StringGets 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() → StringGets 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() → booleanSpecifies whether the link to the OLE object is automatically updated or not in Microsoft Word.
setAutoUpdate(value: boolean)Sets the auto update value.
getOleIcon() → booleanGets the draw aspect of the OLE object.
isLocked() → booleanSpecifies whether the link to the OLE object is locked from updates.
isLocked(value: boolean)Calls isLocked(value) on this OleFormat instance.
getClsid() → java.util.UUIDReturns the clsid.
getOlePackage() → OlePackageProvide access to OlePackage if OLE object is an OLE Package.
getOleControl() → OleControlGets OleControl objects if this OLE object is an ActiveX control.

See Also