All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVInterfaces Interface ENOVIABODocumentTOC
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATBaseDispatch
|
+---System.CATIABase
|
+---ENOVInterfaces.ENOVIABusinessObject
|
+---ENOVInterfaces.ENOVIABOVersionMaster
|
+---ENOVIABODocumentTOC
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIABODocumentTOC
Interface to define a document TOC object as a Business Object.
Role : Document TOC represents a multi-sheet document. TOC by itself acts like one document
that links to many sheet documents.
As it is a kind of VersionMaster object, a TOC is versionnable.
- See also:
- ENOVIABODocument, ENOVIABusinessObject
Method Index
- o
get_AllSheets(CATListPtrENOVIABO*&)
- This method retrieves all the sheets (excludes the index sheet) under this TOC.
- o
get_SheetByNum(long,ENOVIABusinessObject_var&)
- This method retrieves a sheet by sheet number under this TOC.
- o
get_TotalSheetCount(long&)
- This method retrieves the total number of the sheets under this TOC.
Methods
o get_AllSheets
-
This method retrieves all the sheets (excludes the index sheet) under this TOC.
- Parameters:
-
- oSheets
- The list of sheet documents.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o get_SheetByNum
public virtual HRESULT __stdcall get_SheetByNum( | const long | iSheetNumber, |
| ENOVIABusinessObject_var& | oSheets)=0 |
-
This method retrieves a sheet by sheet number under this TOC. Note: index sheet (if there is one) can be retrieved using sheet number 0.
- Parameters:
-
- iSheetNumber
- The sheet number.
- oSheet
- The sheet document. NULL if not found.
- Returns:
- S_OK if successful. S_FALSE if no such sheet is found.
E_FAIL in case of error.
o get_TotalSheetCount
-
This method retrieves the total number of the sheets under this TOC. Note: index sheet (if there is one) is never counted in the total number.
- Parameters:
-
- oTotalNumber
- The total sheet number.
- Returns:
- S_OK if successful. E_FAIL in case of error.
This object is included in the file: ENOVIABODocumentTOC.h
If needed, your Imakefile.mk should include the module: GUIDENOVInterfaces