All Frameworks  Class Hierarchy  This Framework  Indexes   

ENOVDDManager Interface ENOVITOCVersion

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


interface ENOVITOCVersion

Interface for ENOVITOCVersion.
Role: This interface provides methods to manipulate sheets under multi-sheet document (TOC). It is implemented in ENOVDDManager/VX0DDUtil.m.


Method Index


o IsSheetNumUsed(long,boolean&)
Checks whether a sheet number has been used in this TOC.
o NewVersion(ENOVITOCVersion_var&)
Create new TOC version.
o addSheet(CATUnicodeString,CATIVpmFactoryObject_var)
Adds a new sheet.
o connectSheet(CATIVpmFactoryObject_var,boolean&)
Connects a sheet to this TOC.
o connectSheet(CATIVpmFactoryObject_var)
Connects a sheet to this TOC.
o createIndexSheet()
Create Index sheet.
o disconnectSheet(CATIVpmFactoryObject_var)
Disconnects a sheet from this TOC.
o generateHTMLStream(CATUnicodeString&)
Generate HTML stream for index sheet.
o generateXMLStream(CATUnicodeString&)
Generate XML stream for index sheet.
o get_MIMEType(CATListOfCATUnicodeString&)
Retrieves all the MIMETypes of sheets under this TOC.
o retrieveIndexSheet(CATIVpmFactoryObject_var&)
Retrieves Index sheet of this TOC.
o retrieveSheetsWithIndex(CATLISTV(CATIVpmFactoryObject_var)&)
Retrieves all the sheets (include Index sheet) under this TOC.
o retrieveSheets(CATLISTV(CATIVpmFactoryObject_var)&)
Retrieves all the sheets under this TOC.
o reviseSheetLink(CATIVpmFactoryObject_var,CATIVpmFactoryObject_var)
Revises one sheet.
o setPageCount(long,long)
Set page count on the given sheet.
o setPageCounts(long[])
Set page counts on all the sheets.

Methods


o IsSheetNumUsed
public virtual IsSheetNumUsed( iSheetNum,
oNumIsUsed)
Checks whether a sheet number has been used in this TOC.
Parameters:
iSheetNum
The sheet number
oNumIsUsed
The result boolean value
Returns:
S_OK if successful. E_FAIL in case of error.
o NewVersion
public virtual NewVersion( oTOCVer)
Create new TOC version.
Parameters:
oTOCVer
The new TOC version
Returns:
S_OK if successful. E_FAIL in case of error.
o addSheet
public virtual addSheet( iSheetNumStr,
iSheetRevision)
Adds a new sheet.
Parameters:
iSheetNumStr
The sheet number
iSheetRevision
The sheet revision
Returns:
S_OK if successful. E_FAIL in case of error.
o connectSheet
public virtual connectSheet( iSheetRevision,
iReconnectFlag)
Connects a sheet to this TOC.
Parameters:
iSheetRevision
iReconnectFlag
The sheet revision
Returns:
S_OK if successful. E_FAIL in case of error.
o connectSheet
public virtual connectSheet( iSheetRevision)
Connects a sheet to this TOC.
Parameters:
iSheetRevision
The sheet revision
Returns:
S_OK if successful. E_FAIL in case of error.
o createIndexSheet
public virtual createIndexSheet()
Create Index sheet.
Returns:
S_OK if successful. E_FAIL in case of error.
o disconnectSheet
public virtual disconnectSheet( iSheetRevision)
Disconnects a sheet from this TOC.
Parameters:
iSheetRevision
The sheet revision
Returns:
S_OK if successful. E_FAIL in case of error.
o generateHTMLStream
public virtual generateHTMLStream( oHTMLStream)
Generate HTML stream for index sheet.
Parameters:
oHTMLStream
The HTML stream output
Returns:
S_OK if successful. E_FAIL in case of error.
o generateXMLStream
public virtual generateXMLStream( oXMLStream)
Generate XML stream for index sheet.
Parameters:
oXMLStream
The XML stream output
Returns:
S_OK if successful. E_FAIL in case of error.
o get_MIMEType
public virtual get_MIMEType( oTypes)
Retrieves all the MIMETypes of sheets under this TOC.
Parameters:
oTypes
The list of MIMETypes
Returns:
S_OK if successful. E_FAIL in case of error.
o retrieveIndexSheet
public virtual retrieveIndexSheet( oSheet)
Retrieves Index sheet of this TOC.
Parameters:
oSheet
The Index Sheet
Returns:
S_OK if successful. E_FAIL in case of error.
o retrieveSheetsWithIndex
public virtual retrieveSheetsWithIndex( oSheetList)
Retrieves all the sheets (include Index sheet) under this TOC.
Parameters:
oSheetList
The list of sheets
Returns:
S_OK if successful. E_FAIL in case of error.
o retrieveSheets
public virtual retrieveSheets( oSheetList)
Retrieves all the sheets under this TOC.
Parameters:
oSheetList
The list of sheets
Returns:
S_OK if successful. E_FAIL in case of error.
o reviseSheetLink
public virtual reviseSheetLink( iOldRev,
oNewRev)
Revises one sheet.
Parameters:
iOldRev
The sheet revision
oNewRev
The new sheet revision
Returns:
S_OK if successful. E_FAIL in case of error.
o setPageCount
public virtual setPageCount( iSheetNum,
iPageCount)
Set page count on the given sheet.
Parameters:
iSheetNum
The sheet number
iPageCount
The page count
Returns:
S_OK if successful. E_FAIL in case of error.
o setPageCounts
public virtual setPageCounts( iPages)
Set page counts on all the sheets.
Parameters:
iPages
The list of page counts
Returns:
S_OK if successful. E_FAIL in case of error.

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

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