All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATPDMBaseInterfaces Interface CATIPDMUEDocumentName
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIPDMUEDocumentName
Usage: you can freely reimplement this interface.
interface CATIPDMUEDocumentName
This interface is a user exit.
Role: allows to overload the * Document Display Name
in the CATIA session for ENOVIA documents.
- By default, if this interface is not implemented, the Document Display
name is computed from the V_ID ENOVIA V5 Document Master attribute and
from the V_version ENOVIA V5 Document Revision attribute. The
Free Naming option enables to use another Document Master attribute
instead of V_ID.
- The implementation of this interface should preferably combine
the Attribute Mapping process and CATIA APIs to retrieve ENOVIAV5
attribute values
Method Index
- o
ComputeDocumentName(CATDocument*,CATUnicodeString&)
- ComputeDocumentName:
Called by CATIA every time an application requests a document display name for display purposes.
- o
ComputeDocumentName(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
- ComputeDocumentName:
Called by CATIA when the document is not yet loaded in CATIA session.
Methods
o ComputeDocumentName
-
ComputeDocumentName:
Called by CATIA every time an application requests a document display name for display purposes.
- Parameters:
-
- iDocumentV_ID
- Pointer to document in session
- oDocumentName
- The document name to display
- Returns:
- S_FALSE : CATIA should use the default document name
S_OK : Success
E_FAIL : Failure
o ComputeDocumentName
-
ComputeDocumentName:
Called by CATIA when the document is not yet loaded in CATIA session.
For future use, not called in VR5R17.
- Parameters:
-
- iDocumentDomain
- ENOVIAV5 domain name the document belongs to
- iDocumentV_ID
- Value of the ENOVIA V5 DocumentMaster V_ID attribute
- iDocumentV_version
- Value of the ENOVIA V5 DocumentRevision V_version attribute
- iDocumentV_extension
- Value of the ENOVIA V5 DocumentRevision V_extension attribute
- iPartV_ID
- Value of the ENOVIA V5 PartMaster V_ID attribute (for CATPart and CATProduct documents)
- iPartV_vesion
- Value of the ENOVIA V5 PartVersion V_version attribute (for CATPart and CATProduct documents)
- oDocumentName
- The document name to display
- Returns:
- S_FALSE : CATIA should use the default document name
S_OK : Success
E_FAIL : Failure
This object is included in the file: CATIPDMUEDocumentName.h
If needed, your Imakefile.mk should include the module: CATPDMBaseItf