OleFormat (Aspose.Words for Java API Reference)

java.lang.Object
- 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.getOleFormat() property to access the data of an OLE object. You do not create instances of the OleFormat class directly.

See Also:

Shape.getOleFormat()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getAutoUpdate()` 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.
`OleControl`	`getOleControl()` Gets `getOleControl()` objects if this OLE object is an ActiveX control.
`byte[]`	`getOleEntry(java.lang.String oleEntryName)`
`boolean`	`getOleIcon()` Gets the draw aspect of the OLE object.
`OlePackage`	`getOlePackage()` Provide access to `OlePackage` if OLE object is an OLE Package.
`java.lang.String`	`getProgId()` Gets the ProgID of the OLE object.
`byte[]`	`getRawData()` Gets OLE object raw data.
`java.lang.String`	`getSourceFullName()` Gets the path and name of the source file for the linked OLE object.
`java.lang.String`	`getSourceItem()` Gets 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.
`java.lang.String`	`getSuggestedFileName()` Gets the file name suggested for the current embedded object if you want to save it into a file.
`boolean`	`isLink()` Returns true if the OLE object is linked (when `getSourceFullName()` / `setSourceFullName(java.lang.String)` is specified).
`boolean`	`isLocked()` Specifies whether the link to the OLE object is locked from updates.
`void`	`isLocked(boolean value)` Specifies whether the link to the OLE object is locked from updates.
`void`	`save(java.io.OutputStream stream)`
`void`	`save(java.lang.String fileName)` Saves the data of the embedded object into a file with the specified name.
`void`	`setAutoUpdate(boolean value)` Specifies whether the link to the OLE object is automatically updated or not in Microsoft Word.
`void`	`setProgId(java.lang.String value)` Sets the ProgID of the OLE object.
`void`	`setSourceFullName(java.lang.String value)` Sets the path and name of the source file for the linked OLE object.
`void`	`setSourceItem(java.lang.String value)` Sets a string that is used to identify the portion of the source file that is being linked.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - save
```
public void save(java.io.OutputStream stream)
          throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - save
```
public void save(java.lang.String fileName)
          throws java.lang.Exception
```
    Saves the data of the embedded object into a file with the specified name.
    
    Parameters:
    
    fileName - Name of the file to save the OLE object data.
    
    Throws:
    
    java.lang.IllegalStateException - Throws if you attempt to save a linked object.
    
    java.lang.Exception
  - getIconCaption
```
public java.lang.String getIconCaption()
                                throws java.lang.Exception
```
    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.
    
    Returns:
    
    Icon caption of OLE object.
    
    Throws:
    
    java.lang.Exception
  - getSuggestedExtension
```
public java.lang.String getSuggestedExtension()
                                       throws java.lang.Exception
```
    Gets the file extension suggested for the current embedded object if you want to save it into a file.
    
    Returns:
    
    The file extension suggested for the current embedded object if you want to save it into a file.
    
    Throws:
    
    java.lang.Exception
  - getSuggestedFileName
```
public java.lang.String getSuggestedFileName()
                                      throws java.lang.Exception
```
    Gets the file name suggested for the current embedded object if you want to save it into a file.
    
    Returns:
    
    The file name suggested for the current embedded object if you want to save it into a file.
    
    Throws:
    
    java.lang.Exception
  - getOleEntry
```
public byte[] getOleEntry(java.lang.String oleEntryName)
```
  - getRawData
```
public byte[] getRawData()
                  throws java.lang.Exception
```
    Gets OLE object raw data.
    
    Throws:
    
    java.lang.Exception
  - getProgId
```
public java.lang.String getProgId()
```
    Gets the ProgID of the OLE object.
    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.
    
    Returns:
    
    The ProgID of the OLE object.
  - setProgId
```
public void setProgId(java.lang.String value)
```
    Sets the ProgID of the OLE object.
    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.
    
    Parameters:
    
    value - The ProgID of the OLE object.
  - isLink
```
public boolean isLink()
               throws java.lang.Exception
```
    Returns true if the OLE object is linked (when getSourceFullName() / setSourceFullName(java.lang.String) is specified).
    
    Returns:
    
    True if the OLE object is linked (when getSourceFullName() / setSourceFullName(java.lang.String) is specified).
    
    Throws:
    
    java.lang.Exception
  - getSourceFullName
```
public java.lang.String getSourceFullName()
                                   throws java.lang.Exception
```
    Gets the path and name of the source file for the linked OLE object.
    The default value is an empty string.
    
    If getSourceFullName() / setSourceFullName(java.lang.String) is not an empty string, the OLE object is linked.
    
    Returns:
    
    The path and name of the source file for the linked OLE object.
    
    Throws:
    
    java.lang.Exception
  - setSourceFullName
```
public void setSourceFullName(java.lang.String value)
```
    Sets the path and name of the source file for the linked OLE object.
    The default value is an empty string.
    
    If getSourceFullName() / setSourceFullName(java.lang.String) is not an empty string, the OLE object is linked.
    
    Parameters:
    
    value - The path and name of the source file for the linked OLE object.
  - getSourceItem
```
public java.lang.String getSourceItem()
```
    Gets 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 getSourceItem() / setSourceItem(java.lang.String) property might return "Workbook1!R3C1:R4C2" if the OLE object contains only a few cells from the worksheet.
    
    Returns:
    
    A string that is used to identify the portion of the source file that is being linked.
  - setSourceItem
```
public void setSourceItem(java.lang.String value)
```
    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 getSourceItem() / setSourceItem(java.lang.String) property might return "Workbook1!R3C1:R4C2" if the OLE object contains only a few cells from the worksheet.
    
    Parameters:
    
    value - A string that is used to identify the portion of the source file that is being linked.
  - getAutoUpdate
```
public boolean getAutoUpdate()
```
    Specifies whether the link to the OLE object is automatically updated or not in Microsoft Word.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setAutoUpdate
```
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.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getOleIcon
```
public 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.
    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.
    
    Returns:
    
    The draw aspect of the OLE object.
  - isLocked
```
public boolean isLocked()
```
    Specifies whether the link to the OLE object is locked from updates.
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - isLocked
```
public void isLocked(boolean value)
```
    Specifies whether the link to the OLE object is locked from updates.
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getClsid
```
public java.util.UUID getClsid()
```
    Gets the CLSID of the OLE object.
    
    Returns:
    
    The CLSID of the OLE object.
  - getOlePackage
```
public OlePackage getOlePackage()
                         throws java.lang.Exception
```
    Provide access to OlePackage if OLE object is an OLE Package. Returns null otherwise. OLE Package is a legacy technology that allows to wrap any file format not present in the OLE registry of a Windows system into a generic package allowing to embed almost anything into a document. See OlePackage type for more info.
    
    Returns:
    
    The corresponding OlePackage value.
    
    Throws:
    
    java.lang.Exception
  - getOleControl
```
public OleControl getOleControl()
                         throws java.lang.Exception
```
    Gets getOleControl() objects if this OLE object is an ActiveX control. Otherwise this property is null.
    
    Returns:
    
    getOleControl() objects if this OLE object is an ActiveX control.
    
    Throws:
    
    java.lang.Exception

Class OleFormat

Method Summary

Methods inherited from class java.lang.Object

Method Detail

save

save

getIconCaption

getSuggestedExtension

getSuggestedFileName

getOleEntry

getRawData

getProgId

setProgId

isLink

getSourceFullName

setSourceFullName

getSourceItem

setSourceItem

getAutoUpdate

setAutoUpdate

getOleIcon

isLocked

isLocked

getClsid

getOlePackage

getOleControl