All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMDesktopObjects Interface CATIAVPMVDAPaste
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATBaseDispatch
|
+---System.CATIABase
|
+---VPMDesktopObjects.CATIAVPMVDACommand
|
+---CATIAVPMVDAPaste
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIAVPMVDAPaste
Interface to paste an Business Object already put in the buffer.
Role : The object, or list of objects, to paste must be put in the
server buffer by a cut or copy command, before trying to attempt a paste.
With this mechanism, every object present in the buffer will be pasted.
Method Index
- o
get_ParentBObject(ENOVIABusinessObject*&)
- Gets the object on which to paste the buffered objects.
- o
get_PasteMode(long&)
- Gets the paste type : paste under or paste link.
- o
get_Result(long,ENOVIABusinessObject*&)
- Gets the object pasted given by its index.
- o
get_ResultCount(long&)
- Gets the number of buffered objects that have been pasted on the parent Business Object.
- o
put_ParentBObject(ENOVIABusinessObject*)
- Sets the object on which to paste the buffered objects.
- o
put_PasteMode(long)
- Sets the paste type : paste under or paste link.
- o
setPasteToReference(boolean)
- Sets whether the paste should be to the reference or to the instance.
Methods
o get_ParentBObject
-
Gets the object on which to paste the buffered objects. It is designed for user-exit for the customer, and should not be used in another context.
- Parameters:
-
- oObject
- The object on which to paste.
- Returns:
- S_OK in case of success, E_FAIL if the object to paste on is null.
o get_PasteMode
-
Gets the paste type : paste under or paste link.
- Parameters:
-
- oMode
- The paste type.
Legal values: PasteUnder, PasteLink.
- Returns:
- Always S_OK.
o get_Result
-
Gets the object pasted given by its index.
- Parameters:
-
- iIndex
- The index of the pasted object given by get_ResultCount.
- oObject
- The pasted object.
- Returns:
- Always S_OK.
o get_ResultCount
-
Gets the number of buffered objects that have been pasted on the parent Business Object.
- Parameters:
-
- oNbItems
- Number of objects pasted.
- Returns:
- Always S_OK.
o put_ParentBObject
-
Sets the object on which to paste the buffered objects.
- Parameters:
-
- iObject
- The object on which to paste.
- Returns:
- S_OK in case of success, E_FAIL if object is null.
o put_PasteMode
-
Sets the paste type : paste under or paste link.
- Parameters:
-
- iMode
- The paste type.
Legal values: PasteUnder, PasteLink.
- Returns:
- Always S_OK.
o setPasteToReference
-
Sets whether the paste should be to the reference or to the instance.
- Parameters:
-
- pasteToReference
- A boolean indicating if the paste should be to the reference.
- Returns:
- Always S_OK.
This object is included in the file: CATIAVPMVDAPaste.h
If needed, your Imakefile.mk should include the module: VDO0Commands