All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisResources Class CATESamImportDefineAdaptor

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATAnalysisInterfaces.CATISamImportDefine
        |
        +---CATESamImportDefineAdaptor
 

Usage: you can derive this class.


public class CATESamImportDefineAdaptor

Adapter for the implementation of CATISamImportDefine interface.
It can be used for customisation of file import.

See also:
CATISamImportDefine


Constructor and Destructor Index


o CATESamImportDefineAdaptor()
Default constructor.
o ~CATESamImportDefineAdaptor()
Destructor.

Method Index


o Accept()
Implements the OK action.
o GetCommentForType(CATString,CATUnicodeString&)
Associate a comment to the file extention.
o GetFileTypes(CATListValCATString&)
Defines the type of file that will be imported.
o GetUserFrame(CATDialog*,CATDocument*)
Returns an interactive frame.
o GetValues(CATSafeArrayVariant*&)
Get values for customisation.
o Import(CATDocument*,CATDocument*)
Import in order to launch the import specific code.
o SetValues(CATSafeArrayVariant*)
Set Values for customisation.

Constructor and Destructor


o CATESamImportDefineAdaptor
public CATESamImportDefineAdaptor()
Default constructor.
o ~CATESamImportDefineAdaptor
public virtual ~CATESamImportDefineAdaptor()
Destructor.

Methods


o Accept
public HRESULT Accept()
Implements the OK action.
o GetCommentForType
public HRESULT GetCommentForType( const CATString iType,
CATUnicodeString& oComment)
Associate a comment to the file extention.
Parameters:
oComment
String that defines the comment.
o GetFileTypes
public HRESULT GetFileTypes(CATListValCATString& oTypes)
Defines the type of file that will be imported.
Parameters:
oTypes
String that defines the extention of the file.
o GetUserFrame
public CATDlgFrame* GetUserFrame(CATDialog* iParent,
CATDocument* iImportedDoc)
Returns an interactive frame.
Parameters:
iParent
the parent for output frame.
iImpotedDoc
pointer to the imported document.
Returns:
the frame to display.
o GetValues
public HRESULT GetValues(CATSafeArrayVariant*& oValues)
Get values for customisation.
Parameters:
oValues
array of values.
o Import
public HRESULT Import(CATDocument* iFileToImport,
CATDocument* iAnalysisDocument)
Import in order to launch the import specific code.
Parameters:
iFileToImport
input the CATDocument to import.
iAnalysisDocument
input the current CATDocument in which the import is done.
o SetValues
public HRESULT SetValues(CATSafeArrayVariant* iValue)
Set Values for customisation.
Parameters:
iValues
array of values.

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

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