com.spire.doc.fields
Class DocOleObject

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.DocumentObject
              com.spire.doc.DocumentBase
                  com.spire.doc.fields.ParagraphBase
                      com.spire.doc.fields.shapes.ShapeBase
                          com.spire.doc.fields.shapes.Shape
                              com.spire.doc.fields.ShapeObject
                                  com.spire.doc.fields.DocOleObject

All Implemented Interfaces:

IDocumentObject, IDocumentSerializable, IParagraphBase

public class DocOleObject
extends ShapeObject

Constructor Summary

DocOleObject(Document doc)
Initializes a new instance of the OleObject class.

Method Summary

CharacterFormat	getCharacterFormat() Gets shape object's character format.
com.spire.ms.System.IO.Stream	getContainer() Gets the OLE container.
boolean	getDisplayAsIcon() Gets or sets whether the OLEObject is displayed as an Icon or Content.
DocumentObjectType	getDocumentObjectType() Gets the type of the document object.
java.lang.String	getLinkPath() Gets or sets 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 or sets 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 package (only if OleType is "Package").
java.lang.String	getProgId() Gets the programmatic identifier of the OLE object of an undefined type.
void	setDisplayAsIcon(boolean value)
void	setLinkPath(java.lang.String value) Gets or sets the link path.
void	setNativeData(byte[] nativeData) Sets the native data.
void	setObjectType(java.lang.String value) Gets or sets the type of the OLE object.
void	setOlePicture(DocPicture picture) Sets the OLE picture.

Methods inherited from class com.spire.doc.fields.ShapeObject

getChart, getChildObjects, getExtrusionEnabled, getFillColor, getLineDashing, getLineStyle, getShadowEnabled, getStrokeColor, getStrokeWeight, getWordArt, setFillColor, setFillTransparency, setLineDashing, setLineStyle, setStrokeColor, setStrokeWeight

Methods inherited from class com.spire.doc.fields.shapes.Shape

getFirstParagraph, getLastParagraph, hasChart, hasImage

Methods inherited from class com.spire.doc.fields.shapes.ShapeBase

adjustWithEffects, getAllowOverlap, getAlternativeText, getAspectRatioLocked, getBehindText, getBottom, getCoordOrigin, getCoordSize, getDistanceBottom, getDistanceLeft, getDistanceRight, getDistanceTop, getFill, getHeight, getHorizontalAlignment, getHorizontalOrigin, getHorizontalPosition, getRight, getRotation, getShapeType, getSize, getTextWrappingStyle, getTextWrappingType, getVerticalAlignment, getVerticalOrigin, getVerticalPosition, getWidth, getWrapType, getZOrder, isHidden, isHidden, isSignatureLine, localToParent, setAllowOverlap, setAlternativeText, setAspectRatioLocked, setBehindText, setCoordOrigin, setCoordSize, setDistanceBottom, setDistanceLeft, setDistanceRight, setDistanceTop, setHeight, setHorizontalAlignment, setHorizontalOrigin, setHorizontalPosition, setRotation, setShapeType, setTextWrappingStyle, setTextWrappingType, setVerticalAlignment, setVerticalOrigin, setVerticalPosition, setWidth, setWrapType, setZOrder

Methods inherited from class com.spire.doc.fields.ParagraphBase

applyCharacterFormat, applyStyle, getDeleteRevision, getInsertRevision, getNextWidgetSibling, getOwnerParagraph, getPreviousWidgetSibling, getStyleName, isDeleteRevision, isInsertRevision

Methods inherited from class com.spire.doc.DocumentObject

deepClone, getFirstChild, getLastChild, getNextSibling, getOwner, getPreviousSibling, isComposite, prependChild, toString

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

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

deepClone, getDocument, getNextSibling, getOwner, getPreviousSibling, isComposite

Constructor Detail

DocOleObject

public DocOleObject(Document doc)

Initializes a new instance of the OleObject class.

Parameters:

doc - The doc.

Method Detail

getDisplayAsIcon

public boolean getDisplayAsIcon()

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

Returns:

bool

setDisplayAsIcon

public void setDisplayAsIcon(boolean value)

getOlePicture

public DocPicture getOlePicture()

Gets the OLE picture.

Returns:

The OLE picture.

getDocumentObjectType

public DocumentObjectType getDocumentObjectType()

Gets the type of the document object.

Specified by:

getDocumentObjectType in interface IDocumentObject

Overrides:

getDocumentObjectType in class ShapeObject

Returns:

The type of the document object.

getContainer

public com.spire.ms.System.IO.Stream getContainer()

Gets the OLE container.

Returns:

getCharacterFormat

public CharacterFormat getCharacterFormat()

Description copied from class: ShapeObject

Gets shape object's character format.

Overrides:

getCharacterFormat in class ShapeObject

Returns:

The paragraph item character format.

getOleStorageName

public java.lang.String getOleStorageName()

Gets the name of the OLE Object storage.

Returns:

The name of the OLE storage.

getLinkPath

public java.lang.String getLinkPath()

Gets or sets the link path.

Returns:

The link address.

setLinkPath

public void setLinkPath(java.lang.String value)

Gets or sets the link path.

getLinkType

public OleLinkType getLinkType()

Gets the type of the OLE object.

Returns:

The type of the OLE obj.

getProgId

public java.lang.String getProgId()

Gets the programmatic identifier of the OLE object of an undefined type.

getObjectType

public java.lang.String getObjectType()

Gets or sets the type of the OLE object.

Returns:

The type of the object.

setObjectType

public void setObjectType(java.lang.String value)

Gets or sets the type of the OLE object.

getNativeData

public byte[] getNativeData()

Gets the native data of embedded OLE object.

Returns:

The native data.

getPackageFileName

public java.lang.String getPackageFileName()

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

setNativeData

public void setNativeData(byte[] nativeData)

Sets the native data.

Parameters:

nativeData - The native data.

setOlePicture

public void setOlePicture(DocPicture picture)

Sets the OLE picture.

Parameters:

picture - The picture.