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 ConstructorC1MultiDocument ConstructorInitializes a new instance of the C1MultiDocument type.  
    Top
    Public Properties
     NameDescription
    Public PropertyBusyStateGets the current busy state of the current document.  
    Public PropertyCancelGets 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 PropertyContainer (Inherited from System.ComponentModel.Component)
    Public PropertyDocumentNameGets or sets the name of the document (used to identify documents in print tasks and so on).  
    Public PropertyDoEventsGets or sets a value indicating whether the current C1MultiDocument should handle Windows messages while generating.

    The default value is false.

     
    Public PropertyEmfTypeGets 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 PropertyIsDirtyGets a value indicating whether the current C1MultiDocument has been changed since it was last generated.  
    Public PropertyIsEmptyGets a value indicating whether the current C1MultiDocument is empty, i.e. has no C1MultiDocumentItem objects with data.  
    Public PropertyIsGeneratingIndicates whether the document is currently being generated.  
    Public PropertyItemsGets the collection of C1MultiDocumentItem objects containing documents included in the current C1MultiDocument.  
    Public PropertyOutlinesGets 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 PropertyPageCountGets the total number of pages in the current multi-document.  
    Public PropertySite (Inherited from System.ComponentModel.Component)
    Public PropertyStoragePathGets the temporary directory used by the current multi-document if its temporary storage type is StorageType.Disk.  
    Public PropertyStorageTypeGets the temporary storage type used by the current multi-document.  
    Public PropertyUseGdiPlusTextRenderingGets 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 PropertyUserDataGets or sets arbitrary data associated with the current document.  
    Top
    Protected Properties
     NameDescription
    Protected PropertyCanRaiseEvents (Inherited from System.ComponentModel.Component)
    Protected PropertyDesignMode (Inherited from System.ComponentModel.Component)
    Protected PropertyEvents (Inherited from System.ComponentModel.Component)
    Top
    Public Methods
     NameDescription
    Public MethodClearClears the current C1MultiDocument.  
    Public MethodClearGeneratedPagesClears the pages and other info created during document generation. This method does not clear the document structure/content though.  
    Public MethodCreateObjRef (Inherited from System.MarshalByRefObject)
    Public MethodDisposeOverloaded. Overridden. Overridden. Disposes the current object.  
    Public MethodExportOverloaded. Exports the current multi-document to a disk file.  
    Public MethodFindAnchorFor internal use only.  
    Public MethodGenerateGenerates the current C1MultiDocument.  
    Public MethodGetLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodGetPageInfoOverloaded. Retrieves extended information about a page with the specified index.  
    Public MethodInitializeLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodLoadOverloaded. Loads the current document from a stream.  
    Public MethodMakeOutlinesBuilds 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 MethodPageAsMetafileOverloaded. Gets a System.Drawing.Imaging.Metafile that represents the specified page.  
    Public MethodPrintOverloaded. Prints the current document with default printer settings, not showing the print progress dialog.  
    Public MethodPrintDialogOverloaded. Shows the standard print dialog, allowing the user to print the current document.  
    Public MethodSaveOverloaded. Saves the current document to a stream.  
    Public MethodSetStorageOverloaded. 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 MethodToString (Inherited from System.ComponentModel.Component)
    Top
    Protected Methods
     NameDescription
    Protected MethodFinalize (Inherited from System.ComponentModel.Component)
    Protected MethodGetService (Inherited from System.ComponentModel.Component)
    Protected MethodMemberwiseCloneOverloaded.  (Inherited from System.MarshalByRefObject)
    Top
    Public Events
     NameDescription
    Public EventBusyStateChangedOccurs when the BusyState property value has changed.  
    Public EventDisposed (Inherited from System.ComponentModel.Component)
    Public EventDocumentEndedOccurs when the document generation has ended.  
    Public EventDocumentStartingOccurs when the document generation is starting.  
    Public EventItemAddedOccurs when a C1MultiDocumentItem has been added to the current multi-document's Items collection.  
    Public EventItemAddingOccurs when a C1MultiDocumentItem is about to be added to the current multi-document's Items collection.  
    Public EventItemGeneratedOccurs 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 EventItemGeneratingOccurs when the generation of a document or report associated with a C1MultiDocumentItem is about to start.  
    Public EventItemLoadedOccurs 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 EventItemRemovedOccurs when a C1MultiDocumentItem has been removed from the current multi-document's Items collection.  
    Public EventItemRemovingOccurs when a C1MultiDocumentItem is about to be removed from the current multi-document's Items collection.  
    Public EventItemsClearOccurs when the current multi-document's Items collection has been cleared.  
    Public EventItemsClearingOccurs when the current multi-document's Items collection is about to be cleared.  
    Public EventLongOperationOccurs periodically during document generation. Allows to provide progress indication and the ability to cancel generation by the user.  
    Public EventPagesAddedOccurs when one or more pages were added to the current multi-document.  
    Public EventPagesChangedOccurs when one or more pages within the current multi-document were changed.  
    Public EventPagesClearOccurs when all pages within the current multi-document were removed.  
    Top
    See Also

    Reference

    C1MultiDocument Class
    C1.C1Preview Namespace