All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVDesktopDocumentBOCmds Interface ENOVIAVDADocConvertToMultiSheet
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATBaseDispatch
|
+---System.CATIABase
|
+---VPMDesktopObjects.CATIAVPMVDACommand
|
+---ENOVIAVDADocConvertToMultiSheet
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIAVDADocConvertToMultiSheet
Interface to convert a regular document to a multi-sheet document.
Role : This interface creates a new TOC object, and then attach the document as its first sheet to TOC.
Method Index
- o
get_TOC(ENOVIABODocumentTOC_var&)
- This method gets the created TOC object.
- o
put_BObject(ENOVIABusinessObject_var&)
- This method sets the document revision to convert to multi-sheet document.
- o
set_DocDescription(CATUnicodeString&)
- This method sets the description of document.
- o
set_SheetNumber(int)
- This method sets the input sheet number.
- o
set_TOCDescription(CATUnicodeString&)
- This method sets the TOC description.
Methods
o get_TOC
-
This method gets the created TOC object.
- Parameters:
-
- object
- The TOC object.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o put_BObject
public virtual HRESULT __stdcall put_BObject( | const ENOVIABusinessObject_var& | object)=0 |
-
This method sets the document revision to convert to multi-sheet document.
- Parameters:
-
- object
- The document revision to be converted.
- Returns:
- S_OK if the object is valid document revision, S_FALSE if not.
o set_DocDescription
-
This method sets the description of document.
- Parameters:
-
- desc
- The document description
- Returns:
- S_OK.
o set_SheetNumber
-
This method sets the input sheet number. Default is 1.
- Parameters:
-
- iSheetNum
- The input sheet number
- Returns:
- S_OK.
o set_TOCDescription
-
This method sets the TOC description.
- Parameters:
-
- desc
- The TOC description
- Returns:
- S_OK.
This object is included in the file: ENOVIAVDADocConvertToMultiSheet.h
If needed, your Imakefile.mk should include the module: VDD0DocBOCommands