com.spire.doc.fields
Interface IDocOleObject

All Superinterfaces:

IDocumentObject, IParagraphBase

All Known Implementing Classes:

DocOleObject

public interface IDocOleObject
extends IParagraphBase

Interface publishes base the OLE objects

Method Summary

CharacterFormat	getCharacterFormat() gets the current CharacterFormat.
java.io.InputStream	getContainer() Gets the OLE container.
boolean	getDisplayAsIcon() Gets whether the OLEObject is displayed as an Icon or Content.
java.lang.String	getLinkPath() Gets the link path.
OleLinkType	getLinkType() Gets the type of the OLE object.
byte[]	getNativeData() Gets the _native data of embedded OLE object.
java.lang.String	getObjectType() Gets the type of the OLE object.
DocPicture	getOlePicture() Gets the OLE picture.
java.lang.String	getOleStorageName() Gets the name of the OLE Object storage.
java.lang.String	getPackageFileName() Gets the name of file embedded in the openpackage (only if OleType is "Package").
void	setDisplayAsIcon(boolean value) Sets whether the OLEObject is displayed as an Icon or Content.
void	setLinkPath(java.lang.String value) sets the link path.
void	setNativeData(byte[] nativeData) Sets the _native data.
void	setObjectType(java.lang.String value) sets the type of the OLE object.
void	setOlePicture(DocPicture picture) Sets the OLE picture.
void	setOleStorageName(java.lang.String value) Sets the name of the OLE Object storage.

Methods inherited from interface com.spire.doc.interfaces.IParagraphBase

applyStyle, getOwnerParagraph, getStyleName

Methods inherited from interface com.spire.doc.interfaces.IDocumentObject

deepClone, getDocument, getDocumentObjectType, getNextSibling, getOwner, getPreviousSibling, isComposite

Method Detail

getCharacterFormat

CharacterFormat getCharacterFormat()

gets the current CharacterFormat.

Returns:

CharacterFormat

getContainer

java.io.InputStream getContainer()

Gets the OLE container.

Returns:

The container.

getDisplayAsIcon

boolean getDisplayAsIcon()

Gets whether the OLEObject is displayed as an Icon or Content. If True, the OLEObject is displayed as an icon

Returns:

boolean

setDisplayAsIcon

void setDisplayAsIcon(boolean value)

Sets whether the OLEObject is displayed as an Icon or Content.

Parameters:

value - boolean

getLinkPath

java.lang.String getLinkPath()

Gets the link path.

Returns:

The link address.

setLinkPath

void setLinkPath(java.lang.String value)

sets the link path.

Parameters:

value - The link address.

getLinkType

OleLinkType getLinkType()

Gets the type of the OLE object.

Returns:

The type of the OLE obj.

getNativeData

byte[] getNativeData()

Gets the _native data of embedded OLE object.

Returns:

The _native data.

getObjectType

java.lang.String getObjectType()

Gets the type of the OLE object.

Returns:

The type of the object.

setObjectType

void setObjectType(java.lang.String value)

sets the type of the OLE object.

Parameters:

value - The type of the object.

getOlePicture

DocPicture getOlePicture()

Gets the OLE picture.

Returns:

The OLE picture.

getOleStorageName

java.lang.String getOleStorageName()

Gets the name of the OLE Object storage.

Returns:

The name of the OLE storage.

setOleStorageName

void setOleStorageName(java.lang.String value)

Sets the name of the OLE Object storage.

Parameters:

value - The name of the OLE storage.

getPackageFileName

java.lang.String getPackageFileName()

Gets the name of file embedded in the openpackage (only if OleType is "Package").

Returns:

String

setNativeData

void setNativeData(byte[] nativeData)

Sets the _native data.

Parameters:

nativeData - The _native data.

setOlePicture

void setOlePicture(DocPicture picture)

Sets the OLE picture.

Parameters:

picture - The picture.