Library | Package Java Toolkit

Interface DetailOLEObject

package com.ptc.pfc.pfcDetail;

public interface DetailOLEObject
  extends com.ptc.pfc.pfcDetail.DetailItem



Description

This interface represents a drawing-embedded OLE object.
Direct Known Subclasses:
WDetailOLEObject



Method Summary
StringGetApplicationType ()
    Get method for attribute "ApplicationType"
    Returns the type of the object embedded in the model.
Outline2DGetOutline ()
    Get method for attribute "Outline"
    Obtains the extents of the OLE object in the drawing.
/*optional*/ StringGetPath ()
    Get method for attribute "Path"
    Returns the path to the file which is referenced by the OLE object.
intGetSheet ()
    Get method for attribute "Sheet"
    Returns the sheet index on which the OLE object is embedded.

Methods Inherited from Interface com.ptc.pfc.pfcObject.Child
GetDBParent, GetOId

Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource
AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Interface com.ptc.pfc.pfcModelItem.RelationOwner
DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent
GetChild

Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner
GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ModelItem
GetName, SetName, GetId, GetType

Methods Inherited from Interface com.ptc.pfc.pfcDetail.DetailItem
GetDetailType, Delete

Method Detail

GetSheet

intGetSheet ()


    Returns the sheet index on which the OLE object is embedded.
Manual References:
Drawings: OLE Objects



GetOutline

Outline2DGetOutline ()


    Obtains the extents of the OLE object in the drawing.
Manual References:
Drawings: OLE Objects, Drawings: OLE Objects



GetApplicationType

StringGetApplicationType ()


    Returns the type of the object embedded in the model.
Manual References:
Drawings: OLE Objects, Drawings: OLE Objects



GetPath

/*optional*/ StringGetPath ()


    Returns the path to the file which is referenced by the OLE object.

Returns null if the OLE object is not a link to an external file.

Exceptions thrown (but not limited to):

XToolkitNotFound - The object refers to a fully embedded object and not an external file.


Manual References:
Drawings: OLE Objects, Drawings: OLE Objects