All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVDesktopDocumentBOCmds Interface ENOVIAVDADocPaste

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATBaseDispatch
        |
        +---System.CATIABase
          |
          +---VPMDesktopObjects.CATIAVPMVDACommand
            |
            +---ENOVIAVDADocPaste
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface ENOVIAVDADocPaste

Interface to paste a document onto another document, TOC, Folder, or document tree.
Role : This interface can be used to paste a document onto another document/TOC/Folder/Document tree of content management tree panel. Pasting onto another document is to create a link (link type is usually associated or hieratchical link) between two documents. Pasting onto a TOC is to add this document as a sheet under a TOC (sheet number is mandatory). Pasting onto a Folder is to add the document to a Folder. Pasting onto document tree is to make a copy of this document (kind of making a clone of the document. Only the preferred iteration is copied to the new document. No link is copied).


Method Index


o get_Result(ENOVIABusinessObject_var&)
This method gets the pasted document.
o put_BObject(ENOVIABusinessObject_var&)
This method sets the document to be pasted.
o put_ParentObject(ENOVIABusinessObject_var&)
This method sets the parent object that the document is to be paseted on.
o set_LinkType(CATUnicodeString&)
This method sets the link type in the case to paste the document onto another document.
o set_PasteType(CATUnicodeString&)
This method sets the flag to determine the target of this paste.
o set_SheetNumber(int)
This method sets the sheet number in the case to paste a document onto a TOC.

Methods


o get_Result
public virtual HRESULT __stdcall get_Result(ENOVIABusinessObject_var& object)=0
This method gets the pasted document. If it is in clone document case (pasteType is either PasteOnTree or ClonePasteOnTOC), the result is the newly created document.
Parameters:
object
The pasted document.
Returns:
S_OK in case of success, E_FAIL in case of error.
o put_BObject
public virtual HRESULT __stdcall put_BObject( const ENOVIABusinessObject_var& object)=0
This method sets the document to be pasted. If the parent object is folder, then the object is not limited to document. Document or TOC, or even another folder can be pasted to a folder.
Parameters:
object
The object to be pasted.
Returns:
S_OK if successful. S_FALSE if not.
o put_ParentObject
public virtual HRESULT __stdcall put_ParentObject( const ENOVIABusinessObject_var& object)=0
This method sets the parent object that the document is to be paseted on. If the target is document tree, NULL should be set
Parameters:
object
The parent object the document is to be pasted on.
Returns:
S_OK if the object is valid object (Document/TOC/Folder or NULL). S_FALSE if not.
o set_LinkType
public virtual HRESULT __stdcall set_LinkType( const CATUnicodeString& linkType)=0
This method sets the link type in the case to paste the document onto another document.
Parameters:
linkType
The link type.
Legal values:
AssociatedLink
Documents are linked as associated link (peer-to-peer link).
HierarchicalLink
Document is linked as a hierarchical link of the parent document (parent-child link).
ExternalLink
Documents are linked as external link.
Returns:
S_OK.
o set_PasteType
public virtual HRESULT __stdcall set_PasteType( const CATUnicodeString& pasteType)=0
This method sets the flag to determine the target of this paste.
Parameters:
pasteType
The flag to indicate where the document shall be pasted onto. Default is PasteOnTree.
Legal values:
PasteOnTree
Create a copy of the to-be-pasted document (clone document). TargetObject shall be set to NULL. Note: this copy is not identical to the original document. Only the preferred iteration is copied over and no links on the original document are copied.
PasteOnDocument
Paste document onto another document. The link type is mandatory (Associated, Hierarchical, or External).
PasteOnTOC
Paste document onto a TOC. This action converts the document to be a sheet of the TOC. Sheet number is mandatory.
ClonePasteOnTOC
A copy of the document is created (cloned) and then the copied document is attached to TOC as a sheet. Mainly used when this document is already a sheet of another TOC. Sheet number is mandatory. Note: this copy is not identical to the original document. Only the preferred iteration is copied over and no links on the original document are copied.
PasteOnFolder
Paste document onto Folder. This document is added to a Folder.
Returns:
S_OK.
o set_SheetNumber
public virtual HRESULT __stdcall set_SheetNumber( const int sheetNumber)=0
This method sets the sheet number in the case to paste a document onto a TOC.
Parameters:
sheetNumber
The sheet number. Only positive integers between 1 and 999 are legal values.
Returns:
S_OK.

This object is included in the file: ENOVIAVDADocPaste.h
If needed, your Imakefile.mk should include the module: VDD0DocBOCommands

Copyright © 2003, Dassault Systèmes. All rights reserved.