All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVDesktopDocumentBOCmds Interface ENOVIAVDADocDetach

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

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


interface ENOVIAVDADocDetach

Interface to detach a document from another document, TOC, or Folder.
Role : This interface is used to detach a document from another document/TOC/Folder. Detaching from another document is to delete the link (either associated or hieratchical link) between these two documents. Detaching from a TOC is to detach a sheet from the TOC. Detaching from a Folder is to remove the document (any object) from the Folder.


Method Index


o get_Result(ENOVIABusinessObject_var&)
This method retrieves the detached document.
o put_BObject(ENOVIABusinessObject_var&)
This method sets the document that to be detached.
o put_ParentObject(ENOVIABusinessObject_var&)
This method sets the parent object that the document/object is to be detached from.
o set_DetachType(CATUnicodeString&)
This method sets the flag to determine what type of object the document is to be detached from.
o set_LinkType(CATUnicodeString&)
This method sets the link type in the case to detach the document from another document.
o set_NewDocID(CATUnicodeString&)
This method sets a new document V_ID if the document is to be detached from the last TOC version.

Methods


o get_Result
public virtual HRESULT __stdcall get_Result(ENOVIABusinessObject_var& object)=0
This method retrieves the detached document.
Parameters:
object
The detached 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 that to be detached. If the parent object is folder, then the object is not limited to document. Document or TOC, or even another folder can be detached from folder.
Parameters:
object
The object to be detached.
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/object is to be detached from.
Parameters:
object
The target object.
Returns:
S_OK if successful. S_FALSE if not.
o set_DetachType
public virtual HRESULT __stdcall set_DetachType( const CATUnicodeString& detachType)=0
This method sets the flag to determine what type of object the document is to be detached from.
Parameters:
detachType
The flag to indicate what type of object the document is to be detached from.
Legal values:
DetachFromDocument
Detach document from another document. In this case the link between these two documents will be deleted. The link type is mandatory (Associated, Hierarchical, or External).
DetachFromTOC
Detach document from a TOC. In this case the document must be a sheet of the parent object(TOC) and it will be detached from the TOC. If this sheet document is a sheet of the last TOC version (it is not a sheet of any other TOC versions except the input TOC), it will be converted to a regular document (not being a sheet document any more).
DetachFromFolder
Remove the document from a Folder.
Returns:
S_OK.
o set_LinkType
public virtual HRESULT __stdcall set_LinkType( const CATUnicodeString& linkType)=0
This method sets the link type in the case to detach the document from 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 target document (parent-child link).
ExternalLink
Documents are linked as external link.
Returns:
S_OK.
o set_NewDocID
public virtual HRESULT __stdcall set_NewDocID( const CATUnicodeString& iNewDocID)=0
This method sets a new document V_ID if the document is to be detached from the last TOC version. In this case this sheet document will be converted to a regular document with this new V_ID.
Parameters:
iNewDocID
The new document VID.
Returns:
S_OK.

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

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