All Frameworks Class Hierarchy This Framework Previous Indexes
CATAnalysisInterfaces Class CATSamDocumentTools
CATSamDocumentTools
Usage: you must use this class as is. You should never derive it.
public class CATSamDocumentTools
General tools for document management.
Method Index
- o
AddRenameCB(CATBaseUnknown*,CATBaseUnknown*,CATSubscriberMethod)
- Add a callback to be warned by the renaming of a document
Supports only File environnement.
- o
GetFileStorage(CATDocument*,CATUnicodeString&)
- Retrieves the File path of a CATDocument.
- o
SupportFileSaveMgt(CATDocument*,CATUnicodeString&)
- Toolkit in order to implement Save Management of "Non CATIA Document".
Methods
o AddRenameCB
-
Add a callback to be warned by the renaming of a document
Supports only File environnement.
- Parameters:
-
- iThis
- A pointer to the object that is expected to publish the event, your own document.
- iClientData
- A pointer to the analysis document that manages your external file.
- iMethodToCall
- The subscriber's method to call whenever the Renaming event is published.
Return S_OK if the document is saved
o GetFileStorage
-
Retrieves the File path of a CATDocument.
If the Document is defined as "Non CATIA Document" and this comes from ENOVIA,
a local temporary projection is done on the file system.
- Parameters:
-
- pDoc
- The document.
- oPath
- The document path. Return S_OK if the document path is found
o SupportFileSaveMgt
-
Toolkit in order to implement Save Management of "Non CATIA Document".
Supports only "Non CATIA Document" in File environnement.
Should be called in your implementation of
CATIPersistent.SaveAs .
- Parameters:
-
- pDoc
- The document.
- iCopyName
- The new path. Return S_OK if the document is saved
This object is included in the file: CATSamDocumentTools.h
If needed, your Imakefile.mk should include the module: CATAnalysisToolkit