All Frameworks Class Hierarchy This Framework Previous Indexes
ENOVDDManager Interface ENOVITOCVersion
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---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)
- Connects a sheet to this TOC.
- o
connectSheet(CATIVpmFactoryObject_var,boolean&)
- 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
retrieveSheets(CATLISTV(CATIVpmFactoryObject_var)&)
- Retrieves all the sheets under this TOC.
- o
retrieveSheetsWithIndex(CATLISTV(CATIVpmFactoryObject_var)&)
- Retrieves all the sheets (include Index sheet) 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 HRESULT IsSheetNumUsed( | long | iSheetNum, |
| boolean& | oNumIsUsed)=0 |
-
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 HRESULT NewVersion( | ENOVITOCVersion_var& | oTOCVer)=0 |
-
Create new TOC version.
- Parameters:
-
- oTOCVer
- The new TOC version
- Returns:
- S_OK if successful. E_FAIL in case of error.
o addSheet
-
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
-
Connects a sheet to this TOC.
- Parameters:
-
- iSheetRevision
- The sheet revision
- Returns:
- S_OK if successful. E_FAIL in case of error.
o connectSheet
-
Connects a sheet to this TOC.
- Parameters:
-
- iSheetRevision
-
- iReconnectFlag
- The sheet revision
- Returns:
- S_OK if successful. E_FAIL in case of error.
o createIndexSheet
public virtual HRESULT createIndexSheet( | )=0 |
-
Create Index sheet.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o disconnectSheet
-
Disconnects a sheet from this TOC.
- Parameters:
-
- iSheetRevision
- The sheet revision
- Returns:
- S_OK if successful. E_FAIL in case of error.
o generateHTMLStream
-
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
-
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
-
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 HRESULT retrieveIndexSheet( | CATIVpmFactoryObject_var& | oSheet)=0 |
-
Retrieves Index sheet of this TOC.
- Parameters:
-
- oSheet
- The Index Sheet
- Returns:
- S_OK if successful. E_FAIL in case of error.
o retrieveSheets
public virtual HRESULT retrieveSheets( | CATLISTV(CATIVpmFactoryObject_var)& | oSheetList)=0 |
-
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 retrieveSheetsWithIndex
public virtual HRESULT retrieveSheetsWithIndex( | CATLISTV(CATIVpmFactoryObject_var)& | oSheetList)=0 |
-
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 reviseSheetLink
-
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 HRESULT setPageCount( | long | iSheetNum, |
| long | iPageCount)=0 |
-
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 HRESULT setPageCounts( | long[] | iPages)=0 |
-
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