|
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.OleFormat property to access the data of an OLE object.
You do not create instances of the OleFormat class directly. - See Also:
- Shape.OleFormat
|
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 SourceFullName is specified).
|
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)
|
-
Gets or sets the ProgID of the OLE object.
The default value is an empty string.
isLink | |
public boolean isLink()
|
-
Returns true if the OLE object is linked (when SourceFullName is specified).
getSourceFullName/setSourceFullName | |
public java.lang.String getSourceFullName() / public void setSourceFullName(java.lang.String value)
|
-
Gets or sets the path and name of the source file for the linked OLE object.
The default value is an empty string. If SourceFullName is not an empty string, the OLE object is linked.
getSourceItem/setSourceItem | |
public java.lang.String getSourceItem() / public 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.
The default value is an empty string. For example, if the source file is a Microsoft Excel workbook, the SourceItem
property might return "Workbook1!R3C1:R4C2" if the OLE object contains only a few cells from
the worksheet.
getAutoUpdate/setAutoUpdate | |
public boolean getAutoUpdate() / 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.
getOleIcon/setOleIcon | |
public boolean getOleIcon() / public void setOleIcon(boolean value)
|
-
When true, the OLE object is displayed as an icon.
When false, the OLE object is displayed as content.
isLocked/isLocked | |
public boolean isLocked() / public void isLocked(boolean value)
|
-
Specifies whether the link to the OLE object is locked from updates.
The default value is false.
getClsid | |
public java.util.UUID getClsid()
|
-
Gets the CLSID of the OLE object.
save | |
public void save(java.io.OutputStream stream)
throws java.lang.Exception |
-
Saves the data of an embedded OLE object into the specified stream.
It is the responsibility of the caller to dispose the stream. - Parameters:
stream - Where to save the OLE object data.
save | |
public void save(java.lang.String fileName)
throws java.lang.Exception |
-
Saves the data of an embedded OLE object into the file with the specified name.
- Parameters:
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 |
-
Gets a named stream from OLE object data.
- Parameters:
oleEntryName - Name of OLE data entry stream
- Returns:
- Stream, containing named OLE entry data.
See Also:
Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
Aspose.Words Support Forum - our preferred method of support.
|