![](../../Home/Icons/Home.gif)
![](../icons/UpCNM.gif)
![](../icons/CNMContext.gif)
![](../../Home/Icons/Search.gif)
Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TAbstractDocumentStationery
Inherited By:
None.
Purpose:
The TCompoundDocumentStationery class is a stationery that creates compound documents given a document component or component stationery.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Although it is possible to derive TCompoundDocumentStationery and override CreateRootComponent to create a specialized root component, most developers will provide specialized component stationery instead.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
virtual ~ TCompoundDocumentStationery ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
- virtual TDocumentReference CreateDocument ( const TMultiBinStorageMechanism & theStoreMechanism ) ;
- virtual TDocumentReference CreateDocument ( TDocumentComponent * theRootComponentToAdopt, const TMultiBinStorageMechanism & theStoreMechanism ) ;
- virtual TDocumentReference CreateDocument ( TCompoundDocumentStore & theStore, TCompoundDocument & theDocument ) ;
Interface Category:
API.
Purpose:
- Creates a compound document that uses the specified storage mechanism. This function returns a reference to the new document.
- Creates a compound document for the specified document component that uses the specified storage mechanism. This function returns a reference to the new document.
- Creates an instance of a document on disk, given a document store alias and a document. The store is created and the document is committed to the store.
Calling Context:
- Call this function directly.
- Call this function directly.
- Derived classes can call this function directly. Called by the other two CreateDocument functions.
Parameters:
Return Value:
Returns a reference to the document.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
- TCompoundDocumentStationery ()
- TCompoundDocumentStationery ( const TCompoundDocumentStationery& );
- TCompoundDocumentStationery ( TDocumentComponentStationery * componentStationeryToAdopt );
Interface Category:
API.
Purpose:
- Default constructor.
- Copy constructor.
- Called to create a new stationery object for the specified document component stationery.
Calling Context:
Called only by derived classes.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual TDocumentComponent * CreateRootComponent ()
Interface Category:
API.
Purpose:
Creates a root component for this stationery object. This function delegates to its stationery component's CreateComponent function.
Calling Context:
Derived classes can call this function directly.
Parameters:
Return Value:
Returns the newly created root component.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.