CIP C++ documentation for class "pfcDetailOLEObject"

Class pfcDetailOLEObject

# include <pfcDetail.h> class pfcDetailOLEObject : public virtual pfcDetailItem { xaideclare(pfcDetailOLEObject) ... };

Description

This interface represents a drawing-embedded OLE object.

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Direct Known Subclasses:: wfcWDetailOLEObject

Method Summary


`xstring`	`GetApplicationType ()`
	Returns the type of the object embedded in the model.

`pfcOutline2D_ptr`	`GetOutline ()`
	Obtains the extents of the OLE object in the drawing.

`optional xstring`	`GetPath ()`
	Returns the path to the file which is referenced by the OLE object.

`xint`	`GetSheet ()`
	Returns the sheet index on which the OLE object is embedded.

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Methods Inherited from Class pfcDetailItem:: GetDetailType, Delete

Method Detail

xint GetSheet ()

Returns the sheet index on which the OLE object is embedded.

Manual References:: Drawings: OLE Objects

pfcOutline2D_ptr GetOutline ()

Obtains the extents of the OLE object in the drawing.

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

xstring GetApplicationType ()

Returns the type of the object embedded in the model.

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

optional xstring GetPath ()

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):

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

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