OleObject

Inheritance: java.lang.Object

public class OleObject

Represents an OLE object which can be inserter into Gantt Chart View of an MPP file.

Constructors

ConstructorDescription
OleObject()Initializes a new instance of the OleObject class.

Methods

MethodDescription
getApplicationName()Gets the application name to open the embedded object with.
getContent()Gets the embedded file’s data; null if no data was embedded.
getDisplayAsIcon()Gets a flag indicating that OLE object should be shown either as an icon or as its regular picture.
getFileFormat()Gets the file format of the embedded object.
getFullPath()Gets the full path of the inserted object.
getId()Gets the object id.
getLabel()Gets the label of the inserted object.
getLinked()Gets a value indicating whether the project file contains only a link to the actual data stored at the link source.
getName()Gets the name of the instance of the OLE object.
getTemporaryFile()Gets the path to the temporary file of the inserted object.
getView()Gets the instance of the View (getView()/setView(View)) class the inserted object belongs to.
setApplicationName(String value)Sets the application name to open the embedded object with.
setContent(byte[] value)Sets the embedded file’s data; null if no data was embedded.
setDisplayAsIcon(boolean value)Sets a flag indicating that OLE object should be shown either as an icon or as its regular picture.
setFileFormat(String value)Sets the file format of the embedded object.
setFullPath(String value)Sets the full path of the inserted object.
setId(int value)Sets the object id.
setLabel(String value)Sets the label of the inserted object.
setName(String value)Sets the name of the instance of the OLE object.
setTemporaryFile(String value)Sets the path to the temporary file of the inserted object.
setView(View value)Sets the instance of the View (getView()/setView(View)) class the inserted object belongs to.

OleObject()

public OleObject()

Initializes a new instance of the OleObject class.

getApplicationName()

public final String getApplicationName()

Gets the application name to open the embedded object with.

Returns: java.lang.String - the application name to open the embedded object with.

getContent()

public final byte[] getContent()

Gets the embedded file’s data; null if no data was embedded.

Returns: byte[] - the embedded file’s data; null if no data was embedded.

getDisplayAsIcon()

public final boolean getDisplayAsIcon()

Gets a flag indicating that OLE object should be shown either as an icon or as its regular picture.

Returns: boolean - a flag indicating that OLE object should be shown either as an icon or as its regular picture.

getFileFormat()

public final String getFileFormat()

Gets the file format of the embedded object.

Returns: java.lang.String - the file format of the embedded object.

getFullPath()

public final String getFullPath()

Gets the full path of the inserted object.

Returns: java.lang.String - the full path of the inserted object.

getId()

public final int getId()

Gets the object id.

Returns: int - the object id.

getLabel()

public final String getLabel()

Gets the label of the inserted object.

Returns: java.lang.String - the label of the inserted object.

getLinked()

public final boolean getLinked()

Gets a value indicating whether the project file contains only a link to the actual data stored at the link source.

Returns: boolean - a value indicating whether the project file contains only a link to the actual data stored at the link source.

getName()

public final String getName()

Gets the name of the instance of the OLE object.

Returns: java.lang.String - the name of the instance of the OLE object.

getTemporaryFile()

public final String getTemporaryFile()

Gets the path to the temporary file of the inserted object.

Returns: java.lang.String - the path to the temporary file of the inserted object.

getView()

public final View getView()

Gets the instance of the View (getView()/setView(View)) class the inserted object belongs to.

Returns: View - the instance of the View (getView()/setView(View)) class the inserted object belongs to.

setApplicationName(String value)

public final void setApplicationName(String value)

Sets the application name to open the embedded object with.

Parameters:

ParameterTypeDescription
valuejava.lang.Stringthe application name to open the embedded object with.

setContent(byte[] value)

public final void setContent(byte[] value)

Sets the embedded file’s data; null if no data was embedded.

Parameters:

ParameterTypeDescription
valuebyte[]the embedded file’s data; null if no data was embedded.

setDisplayAsIcon(boolean value)

public final void setDisplayAsIcon(boolean value)

Sets a flag indicating that OLE object should be shown either as an icon or as its regular picture.

Parameters:

ParameterTypeDescription
valuebooleana flag indicating that OLE object should be shown either as an icon or as its regular picture.

setFileFormat(String value)

public final void setFileFormat(String value)

Sets the file format of the embedded object.

Parameters:

ParameterTypeDescription
valuejava.lang.Stringthe file format of the embedded object.

setFullPath(String value)

public final void setFullPath(String value)

Sets the full path of the inserted object.

Parameters:

ParameterTypeDescription
valuejava.lang.Stringthe full path of the inserted object.

setId(int value)

public final void setId(int value)

Sets the object id.

Parameters:

ParameterTypeDescription
valueintthe object id.

setLabel(String value)

public final void setLabel(String value)

Sets the label of the inserted object.

Parameters:

ParameterTypeDescription
valuejava.lang.Stringthe label of the inserted object.

setName(String value)

public final void setName(String value)

Sets the name of the instance of the OLE object.

Parameters:

ParameterTypeDescription
valuejava.lang.Stringthe name of the instance of the OLE object.

setTemporaryFile(String value)

public final void setTemporaryFile(String value)

Sets the path to the temporary file of the inserted object.

Parameters:

ParameterTypeDescription
valuejava.lang.Stringthe path to the temporary file of the inserted object.

setView(View value)

public final void setView(View value)

Sets the instance of the View (getView()/setView(View)) class the inserted object belongs to.

Parameters:

ParameterTypeDescription
valueViewthe instance of the View (getView()/setView(View)) class the inserted object belongs to.