C1MultiDocument Class

Represents a multi-document - a sequence of several documents that have common page numbering, and can be handled (e.g. printed or exported) together as a single large document. Allows creating very large documents without running out of memory.

Inheritance

object

MarshalByRefObject

Component

C1MultiDocument

Implements

IComponent

IDisposable

Namespace: C1.C1Preview

Assembly: C1.WPF.PrintDocument.4.6.2.dll

Syntax

[C1ClassSerialization(true)]
[ToolboxBitmap(typeof(C1MultiDocument), "C1MultiDocument.png")]
[C1OpenXmlSerialization("/document/document.xml")]
public class C1MultiDocument : Component, IComponent, IDisposable

<C1ClassSerialization(True)>
<ToolboxBitmap(GetType(C1MultiDocument), "C1MultiDocument.png")>
<C1OpenXmlSerialization("/document/document.xml")>
Public Class C1MultiDocument
    Inherits Component
    Implements IComponent, IDisposable

Constructors

Name	Description
C1MultiDocument()	Initializes a new instance of the C1MultiDocument type.

Properties

Name	Description
BusyState	Gets the current busy state of the current document.
Cancel	Gets 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.
DoEvents	Gets or sets a value indicating whether the current C1MultiDocument should handle Windows messages while generating. The default value is false.
DocumentName	Gets or sets the name of the document (used to identify documents in print tasks and so on).
EmfType	Gets 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).
IsDirty	Gets a value indicating whether the current C1MultiDocument has been changed since it was last generated.
IsEmpty	Gets a value indicating whether the current C1MultiDocument is empty, i.e. has no C1MultiDocumentItem objects with data.
IsGenerating	Indicates whether the document is currently being generated.
Items	Gets the collection of C1MultiDocumentItem objects containing documents included in the current C1MultiDocument.
Outlines	Gets 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.
PageCount	Gets the total number of pages in the current multi-document.
StoragePath	Gets the temporary directory used by the current multi-document if its temporary storage type is Disk.
StorageType	Gets the temporary storage type used by the current multi-document.
UseGdiPlusTextRendering	Gets 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).
UserData	Gets or sets arbitrary data associated with the current document.

Methods

Name	Description
Clear()	Clears the current C1MultiDocument.
ClearGeneratedPages()	Clears the pages and other info created during document generation. This method does not clear the document structure/content though.
Dispose(bool)	Overridden. Disposes the current object.
Export(Stream, ExportProvider)	Exports the current multi-document to a stream.
Export(Stream, ExportProvider, OutputRange, bool)	Exports the current multi-document to a stream.
Export(Stream, ExportProvider, bool)	Exports the current multi-document to a stream.
Export(string)	Exports the current multi-document to a disk file.
Export(string, ExportProvider, OutputRange, bool)	Exports the current multi-document to a disk file.
Export(string, OutputRange, bool)	Exports the current multi-document to a disk file.
Export(string, bool)	Exports the current multi-document to a disk file.
FindAnchor(string)	For internal use only.
Generate()	Generates the current C1MultiDocument.
GetPageInfo(int, out int, out ResolvedPage)	Retrieves extended information about a page with the specified index.
GetPageInfo(int, out int, out int, out int)	Retrieves extended information about a page with the specified index.
Load(Stream)	Loads the current document from a stream.
Load(string)	Loads the current document from a file.
MakeOutlines()	Builds 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 Outlines property.
PageAsMetafile(int)	Gets a Metafile representing the specified page.
PageAsMetafile(int, PageDrawParams)	Gets a Metafile that represents the specified page.
PageAsMetafile(int, bool, SmoothingMode)	Gets a Metafile that represents the specified page.
Print()	Prints the current document with default printer settings, not showing the print progress dialog.
Print(PrinterSettings)	Prints the current document with specified printer settings, not showing the print progress dialog.
Print(PrinterSettings, OutputRange)	Prints a range of pages within the current document with specified printer settings, not showing the print progress dialog.
Print(PrinterSettings, OutputRange, bool)	Prints a range of pages within the current document with specified printer settings, optionally showing the print progress dialog.
Print(PrinterSettings, bool)	Prints the current document with specified printer settings, optionally showing the print progress dialog.
Print(PrinterSettings, PageSettings, OutputRange)	Prints a range of pages within the current document with specified printer and default page settings, not showing the print progress dialog.
Print(PrinterSettings, PageSettings, OutputRange, bool)	Prints a range of pages within the current document with specified printer and default page settings, optionally showing the print progress dialog.
Print(PrinterSettings, PageSettings, bool)	Prints the current document with specified printer and default page settings, optionally showing the print progress dialog.
PrintDialog()	Shows the standard print dialog, allowing the user to print the current document.
PrintDialog(PrinterSettings, int[], bool)	Shows the standard print dialog, allowing the user to print the current document.
Save(Stream)	Saves the current document to a stream.
Save(string)	Saves the current document to a disk file.
SetStorage(StorageType)	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.
SetStorage(StorageType, string)	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.

Events

Name	Description
BusyStateChanged	Occurs when the BusyState property value has changed.
DocumentEnded	Occurs when the document generation has ended.
DocumentStarting	Occurs when the document generation is starting.
ItemAdded	Occurs when a C1MultiDocumentItem has been added to the current multi-document's Items collection.
ItemAdding	Occurs when a C1MultiDocumentItem is about to be added to the current multi-document's Items collection.
ItemGenerated	Occurs 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.
ItemGenerating	Occurs when the generation of a document or report associated with a C1MultiDocumentItem is about to start.
ItemLoaded	Occurs 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).
ItemRemoved	Occurs when a C1MultiDocumentItem has been removed from the current multi-document's Items collection.
ItemRemoving	Occurs when a C1MultiDocumentItem is about to be removed from the current multi-document's Items collection.
ItemsClear	Occurs when the current multi-document's Items collection has been cleared.
ItemsClearing	Occurs when the current multi-document's Items collection is about to be cleared.
LongOperation	Occurs periodically during document generation. Allows to provide progress indication and the ability to cancel generation by the user.
PagesAdded	Occurs when one or more pages were added to the current multi-document.
PagesChanged	Occurs when one or more pages within the current multi-document were changed.
PagesClear	Occurs when all pages within the current multi-document were removed.