PrintDocument for WinForms | ComponentOne
C1.PrintDocument.4.5.2 Assembly / C1.C1Preview Namespace / C1MultiDocument Class
Properties Methods Events


In This Topic
    C1MultiDocument Class Members
    In This Topic

    The following tables list the members exposed by C1MultiDocument.

    Public Constructors
     NameDescription
    Public ConstructorInitializes a new instance of the C1MultiDocument type.  
    Top
    Public Properties
     NameDescription
    Public PropertyGets the current busy state of the current document.  
    Public PropertyGets or sets a value indicating whether to cancel the generation of the current document. Note that this property is useful only if DoEvents is set to true.  
    Public Property (Inherited from System.ComponentModel.Component)
    Public PropertyGets or sets the name of the document (used to identify documents in print tasks and so on).  
    Public PropertyGets or sets a value indicating whether the current C1MultiDocument should handle Windows messages while generating.

    The default value is false.

     
    Public PropertyGets or sets the type of metafiles created by the current document.

    The default is null (the property is not defined at the multi-document level).

     
    Public PropertyGets a value indicating whether the current C1MultiDocument has been changed since it was last generated.  
    Public PropertyGets a value indicating whether the current C1MultiDocument is empty, i.e. has no C1MultiDocumentItem objects with data.  
    Public PropertyIndicates whether the document is currently being generated.  
    Public PropertyGets the collection of C1MultiDocumentItem objects containing documents included in the current C1MultiDocument.  
    Public PropertyGets the OutlineNodeCollection containing outline nodes specified for the multi-document.

    Note that this collection does not include outlines of documents and reports contained within this multi-document. Use the MakeOutlines method to build the complete outline tree for the multi-document.

    See remarks for more details.

     
    Public PropertyGets the total number of pages in the current multi-document.  
    Public Property (Inherited from System.ComponentModel.Component)
    Public PropertyGets the temporary directory used by the current multi-document if its temporary storage type is StorageType.Disk.  
    Public PropertyGets the temporary storage type used by the current multi-document.  
    Public PropertyGets or sets a value indicating whether text in the current document is rendered using GDI+ text API.

    The default is null (the property is not defined at the multi-document level).

     
    Public PropertyGets or sets arbitrary data associated with the current document.  
    Top
    Protected Properties
    Public Methods
     NameDescription
    Public MethodClears the current C1MultiDocument.  
    Public MethodClears the pages and other info created during document generation. This method does not clear the document structure/content though.  
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodOverloaded. Overridden. Overridden. Disposes the current object.  
    Public MethodOverloaded. Exports the current multi-document to a disk file.  
    Public MethodFor internal use only.  
    Public MethodGenerates the current C1MultiDocument.  
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodOverloaded. Retrieves extended information about a page with the specified index.  
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodOverloaded. Loads the current document from a stream.  
    Public MethodBuilds the outline tree for the current multi-document, merging the multi-document's own outlines (Outlines) and outline trees of documents and reports contained within the multi-document.

    For details, see the remarks section of the property.

     
    Public MethodOverloaded. Gets a System.Drawing.Imaging.Metafile that represents the specified page.  
    Public MethodOverloaded. Prints the current document with default printer settings, not showing the print progress dialog.  
    Public MethodOverloaded. Shows the standard print dialog, allowing the user to print the current document.  
    Public MethodOverloaded. Saves the current document to a stream.  
    Public MethodOverloaded. Sets the temporary storage type used by the current multi-document. Note that document items are actually moved from old storage to new by this method.  
    Public Method (Inherited from System.ComponentModel.Component)
    Top
    Protected Methods
     NameDescription
    Protected Method (Inherited from System.ComponentModel.Component)
    Protected Method (Inherited from System.ComponentModel.Component)
    Protected MethodOverloaded.  (Inherited from System.MarshalByRefObject)
    Top
    Public Events
     NameDescription
    Public EventOccurs when the BusyState property value has changed.  
    Public Event (Inherited from System.ComponentModel.Component)
    Public EventOccurs when the document generation has ended.  
    Public EventOccurs when the document generation is starting.  
    Public EventOccurs when a C1MultiDocumentItem has been added to the current multi-document's Items collection.  
    Public EventOccurs when a C1MultiDocumentItem is about to be added to the current multi-document's Items collection.  
    Public EventOccurs when the generation of a document associated with a C1MultiDocumentItem has completed. On some systems garbage collection does not always work correctly without explicit calls to GC. Use this event to call GC.Collect() to ensure that multi-document generation does not cause an out of memory exception.  
    Public EventOccurs when the generation of a document or report associated with a C1MultiDocumentItem is about to start.  
    Public EventOccurs when a C1MultiDocumentItem has been loaded, parameters (if any) have been prepared, but the report or document represented by the item has not been generated yet. Allows to adjust the properties of the report or document prior to generation (e.g. the data source of a C1Report may be assigned here).  
    Public EventOccurs when a C1MultiDocumentItem has been removed from the current multi-document's Items collection.  
    Public EventOccurs when a C1MultiDocumentItem is about to be removed from the current multi-document's Items collection.  
    Public EventOccurs when the current multi-document's Items collection has been cleared.  
    Public EventOccurs when the current multi-document's Items collection is about to be cleared.  
    Public EventOccurs periodically during document generation. Allows to provide progress indication and the ability to cancel generation by the user.  
    Public EventOccurs when one or more pages were added to the current multi-document.  
    Public EventOccurs when one or more pages within the current multi-document were changed.  
    Public EventOccurs when all pages within the current multi-document were removed.  
    Top
    See Also