PrintDocument for WinForms | ComponentOne
C1.Win.PrintPreview.4.5.2 Assembly / C1.Win.C1Preview.Design Namespace / SampleC1PrintDocument Class
Properties Methods Events


In This Topic
    SampleC1PrintDocument Class Members
    In This Topic

    The following tables list the members exposed by SampleC1PrintDocument.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyGets the C1.C1Preview.RenderInputButton object representing the accept button in the current document (the first C1.C1Preview.RenderInputButton object with C1.C1Preview.RenderInputButton.AcceptButton property set to true). (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the actual measurement device which was used to generate the document. This device can differ from the one specified by C1.C1Preview.C1PrintDocument.CreationDevice, for example if C1.C1Preview.C1PrintDocument.CreationDevice was set to C1.C1Preview.MeasurementDeviceEnum.Printer but the current system has no printers installed. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the name of the actual measurement printer which was used to generate the document. This can differ from the name specified by C1.C1Preview.C1PrintDocument.CreationPrinterName, for example if the report was rendered on a system with no such printer. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets a value indicating whether to add messages to the current document's C1.C1Preview.C1PrintDocument.Warnings collection when script errors are found.

    The default value is false.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets a value indicating whether methods can be called on the current document that would result in the document becoming non-reflowable (such as C1.C1Preview.C1PrintDocument.NewPage). If this property is false, calling such methods throws an exception. If this property is true, calling such methods sets the C1.C1Preview.C1PrintDocument.Reflowable flag to false on the current document.

    The default value is false.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public Property

    This property is obsolete.

    Gets or sets a value indicating whether the C1.C1Preview.C1PrintDocument.EmbeddedFonts collection will be automatically filled with fonts used in the document during document generation.

    The default value is false.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyAn amount of available vertical space in the block flow in the currently generating page area, value specified in the ResolvedUnit units. Returns -1 if document in not generating state. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyAn amount of available horizontal space in the block flow in the currently generating page area, value specified in the ResolvedUnit units. Returns -1 if document in not generating state. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the C1.C1Preview.DocumentBody object representing the body of the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the current busy state of the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets a value indicating whether to cancel the generation of the current document. Note that this property is useful only if C1.C1Preview.C1PrintDocument.DoEvents is set to true. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets a value indicating whether to clip the content of the current document to page margins.

    The default value is false.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the C1.C1Preview.C1PrintDocument.CompatibilityOptions object which determines compatibility with previous versions of C1PrintDocument. (Inherited from C1.C1Preview.C1PrintDocument)
    Public Property (Inherited from System.ComponentModel.Component)
    Public PropertyGets or sets the type of device that is used to provide reference graphics when generating the document. If this property is set to C1.C1Preview.MeasurementDeviceEnum.Printer, C1.C1Preview.C1PrintDocument.CreationPrinterName specifies the printer. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the resolution (DPI) used when generating the document.

    Note that if C1.C1Preview.C1PrintDocument.ResolvedUnit is C1.C1Preview.UnitTypeEnum.Pixel, this is also the resolution of ResolvedUnit pixels.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the System.Drawing.Graphics object to use as reference when generating the report. This Graphics is used to calculate text sizes, measure RTF text, and so on. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the document creation mode. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the name of the printer that is used to provide reference graphics when generating the document.

    This property is only used if C1.C1Preview.C1PrintDocument.CreationDevice is set to C1.C1Preview.MeasurementDeviceEnum.Printer.

    Set this property to null to select the reference printer automatically.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the current Graphics object created by the last call to C1.C1Preview.C1PrintDocument.RenderBlockGraphicsBegin. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the current C1.C1Preview.RenderGraphics object created by the last call to C1.C1Preview.C1PrintDocument.RenderBlockGraphicsBegin. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the current Graphics object created by the last call to C1.C1Preview.C1PrintDocument.RenderDirectGraphicsBegin. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the current C1.C1Preview.RenderGraphics object created by the last call to C1.C1Preview.C1PrintDocument.RenderDirectGraphicsBegin. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the current generating page, returns null if document in not generating state. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the current generating area of page, returns null if document in not generating state. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the effective layout for the current page. That layout is automatically built on the fly by merging all applicable layouts defined for the current document in C1.C1Preview.C1PrintDocument.PageLayouts. You may change the properties on CurrentPageLayout programmatically. The changes will be effective immediately if they are made in the C1.C1Preview.C1PrintDocument.PageConfigure event handler, otherwise they will take effect for the next added page.

    Note that this property is only available during document generation, at other times null is returned.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the C1.C1Preview.DataBinding.C1DataSchema object representing the data schema built into the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the default unit of measurement for the current document. This unit is used when sizes or coordinates of objects within the document are set without specifying the unit of measurement explicitly.

    The default value is C1.C1Preview.UnitTypeEnum.Inch.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the current document's C1.C1Preview.Dictionary. The Dictionary can be used to contain reused resources (e.g. images used in multiple places in the document). (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets a value indicating whether the end user should be prevented from reflowing the document with different page settings. This property is only a hint to the document viewer.

    The default value is false (i.e. reflow is allowed).

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets a System.Drawing.Printing.PrintDocument object that can be used to render the current document into a standard print preview control. Not needed and not recommended if you're using ComponentOne preview controls. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the directory of the C1.C1Preview.C1PrintDocument.DocumentFileName. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the script that is executed when the current document has finished generating. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the file name associated with the current document (i.e. the document was either loaded from that file, or saved to it). (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the collection of C1.C1Preview.DocumentFont objects describing fonts used in the current document.

    This collection is populated automaticallly when the document generates, depending on the value of the C1.C1Preview.C1PrintDocument.FontHandling property on the document.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the C1.C1Preview.C1PrintDocument.DocumentInfo object containing the information about the current document (such as author, company, and so on). (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the script that is executed when the current document starts generating. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets a value indicating whether the current C1.C1Preview.C1PrintDocument should handle Windows messages while generating.

    The default value is false.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the collection of fonts embedded in the current document.

    If C1.C1Preview.C1PrintDocument.FontHandling property on the document has been set to C1.C1Preview.FontHandling.EmbedFonts or C1.C1Preview.FontHandling.EmbedActualFonts, this collection is populated automatically when the document generates.

    Otherwise, this collection is not populated automatically. But you can add fonts to this collection in code, so that just the added fonts will be embedded in the document. Note that in that case you must also explicitly specify the glyphs to include by calling the C1.C1Preview.EmbeddedFont.AddGlyphs method or any of its overloads.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the type of metafiles created by the current document. The default is System.Drawing.Imaging.EmfType.EmfPlusOnly. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyObsolete. Now gets the Code of the first element in the Warnings collection, or GenerateErrorEnum.None if there are no warnings. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyObsolete. Now gets the description of the first element in the Warnings collection, or an empty string if there are no warnings. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the script that is executed when an error occurs in a script attached to the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the collection of all registered C1.C1Preview.Export.ExportProvider objects. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets a value specifying how font embedding and substitution are handled by the current C1.C1Preview.C1PrintDocument. This property is simply a shortcut to C1.C1Preview.FontProcessingOptions.FontHandling. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the C1.C1Preview.C1PrintDocument.FontProcessingOptions object which determines how font subtitution and embedding are handled when the document generates. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the action to be performed when the ENTER key is pressed in a C1.Win.C1Preview.C1PreviewPane control which is viewing the current document.

    The default value is C1.C1Preview.FormsKeyActionEnterEnum.None.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the action to be performed when the TAB key is pressed in a C1.Win.C1Preview.C1PreviewPane control which is viewing the current document.

    The default value is C1.C1Preview.FormsKeyActionTabEnum.MoveAccrossDocOut.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets a C1.C1Preview.FormsStyleEnum value specifying the look and feel of input controls in the current document (see types derived from C1.C1Preview.RenderInputBase).

    The default value is C1.C1Preview.FormsStyleEnum.Acrobat.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyIf the current document is generating (see C1.C1Preview.C1PrintDocument.IsGenerating), gets the approximate completion ratio, from 0 (0% complete) to 1 (100% complete). If the document is currently not generating, gets 1. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the value indicating whether a handler is attached to the C1.C1Preview.C1PrintDocument.GenerateDocument event of the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyIndicates whether the document is currently being generated. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets a value indicating whether all pages have been added to the document being generated.

    For example, if the document has a page footer or header that includes the total page count (of the kind "Page X of Y"), this property gets false while new pages are being added, but true when adding new pages is over and the total page count is being updated on the rendered pages.

    If the document is currently not generating (see C1.C1Preview.C1PrintDocument.IsGenerating), gets true.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets a value indicating whether the document is being generated via C1.C1Preview.C1PrintDocument.StartDoc / C1.C1Preview.C1PrintDocument.EndDoc methods. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the value limiting the maximum number of pages in the generated document.

    The default value is -1, indicating that the number of pages in the document is unlimited.

    This property is only taken into account when the document is created using the C1.C1Preview.C1PrintDocument.Generate method.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the C1.C1Preview.OutlineNodeCollection representing the collection of C1.C1Preview.OutlineNode objects of the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the script that is executed when a new page is added to the document. This script executes after the page has been added to the C1.C1Preview.C1PrintDocument.Pages collection but before it is resolved (i.e. when the content of the page has not been laid out yet).

    This script should be used only to change the page layout. Do not use this script to change the page content, as it may cause errors.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the default page layout for the current document. This property is a shortcut for C1.C1Preview.DocumentPageLayouts.Default. (A page layout includes page settings, page headers and footers, and column definitions.) (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the collection of page layouts used in the current document. In addition to the default layout which is always present, special layouts may be defined for first, last, even and odd pages of the document. The effective layout for each page is then produced by merging all applicable layouts. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the C1.C1Preview.C1PrintDocument.PageNumberingChange object applied to the first page of the document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the collection of document's pages. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets a value indicating whether the document is reflowable. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the C1.C1Preview.UnitTypeEnum value that will be used to specify the resolved sizes of objects within the current document (e.g. the sizes of C1.C1Preview.RenderFragment objects representing the render objects in the document).

    This property cannot be changed when the document is generating (i.e. while C1.C1Preview.C1PrintDocument.IsGenerating returns true).

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the name of the sample document (shown as watermark text).  
    Public PropertyGets the ScriptingOptions object defining the scripting options of this C1PrintDocument object. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets a value indicating whether a dialog allowing to input values for some or all of the user defined tags (elements of the C1.C1Preview.C1PrintDocument.Tags collection) should be shown to the user before the document generates. To include or exclude tags from the dialog, use C1.C1Preview.Tag.ShowInDialog.

    The default value is false.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public Property (Inherited from System.ComponentModel.Component)
    Public PropertyGets or sets the top-level stacking rule for the document body.

    The default value is C1.C1Preview.StackingRulesEnum.BlockTopToBottom.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the main (root) C1.C1Preview.Style of the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the collection of system tags (objects derived from C1.C1Preview.TagSys) associated with the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the string used as the closing parentheses when including references to C1.C1Preview.Tag objects in the current document's texts (e.g. in C1.C1Preview.RenderText.Text or C1.C1Preview.ParagraphText.Text). To include a TagCloseParen string itself in a text, prepend it with the C1.C1Preview.C1PrintDocument.TagEscapeString string.

    The default value is "]".

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the string that can be used to escape C1.C1Preview.C1PrintDocument.TagOpenParen and C1.C1Preview.C1PrintDocument.TagCloseParen. To include a TagEscapeString string itself in a text, duplicate it.

    The default value is "\".

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the string used as the opening parentheses when including references to C1.C1Preview.Tag objects in the current document's texts (e.g. in C1.C1Preview.RenderText.Text or C1.C1Preview.ParagraphText.Text). To include a TagOpenParen string itself in a text, prepend it with the C1.C1Preview.C1PrintDocument.TagEscapeString string.

    The default value is "[".

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the C1.C1Preview.TagCollection representing the collection of user-defined C1.C1Preview.Tag objects in the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the type of form used to input tag values (the form will be shown if C1.C1Preview.C1PrintDocument.ShowTagsInputDialog is true). The form type must be derived from C1.C1Preview.Forms.TagsInputFormBase. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets the type name of form used to input tag values (the form will be shown if C1.C1Preview.C1PrintDocument.ShowTagsInputDialog is true). The form type must be derived from C1.C1Preview.Forms.TagsInputFormBase. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets a value indicating whether an exception should be raised if an error occurs while the current document generates. If this property is false, the C1.C1Preview.C1PrintDocument.Generate method will return false if errors occurred while generating, otherwise an exception will be thrown on the first error.

    The default value is false.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the C1.C1Preview.C1PrintDocument.UsageInfo object containing information related to the current document's usage: date/time of generation, file name last used to save or load the document, and so on. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets a value indicating whether text in the current document should be rendered using the GDI+ text API.

    The default value is false.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets or sets arbitrary data associated with the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public PropertyGets the collection of warnings produced by the document's generation. (Inherited from C1.C1Preview.C1PrintDocument)
    Top
    Protected Properties
    Public Methods
     NameDescription
    Public MethodOverloaded. Adds an anchor (C1.C1Preview.C1Anchor or C1.C1Preview.C1AnchorText) at the current position in the document. Can be used only if C1.C1Preview.C1PrintDocument.IsStartEndDocMode is true. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodAdvances the current block flow position by the specified distance. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodIndicates whether rendering in the block flow is permitted now. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodIndicates whether direct rendering is permitted now. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodClears the current document, sets all properties to their default values. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodClears the pages and other info created during document generation. This method does not clear the document structure/content though. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Converts an absolute C1.C1Preview.Unit value to the specified measurement units (this overload cannot convert to pixels). (Inherited from C1.C1Preview.C1PrintDocument)
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodOverloaded. Releases the resoureces used by C1.C1Preview.C1PrintDocument. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodShows the tags input dialog, allows the user to enter/update the values of C1.C1Preview.Tag objects contained in the C1.C1Preview.C1PrintDocument.Tags collection. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodFinishes generation of a document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Exports the document to a disk file. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodSearches for an C1.C1Preview.C1Anchor with the specified C1.C1Preview.C1Anchor.Name in the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodSearches for the first occurrence of a C1.C1Preview.RenderInputFragment object in the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Converts a double value expressed in the current document's C1.C1Preview.C1PrintDocument.ResolvedUnit units to other C1.C1Preview.UnitTypeEnum units. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Generates the current document, using the C1.C1Preview.RefreshModeEnum.RefreshCalculatedValues refresh mode. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Converts an absolute length represented by a C1.C1Preview.LengthAbs object to a double value expressed in the current document's C1.C1Preview.C1PrintDocument.ResolvedUnit units. (Inherited from C1.C1Preview.C1PrintDocument)
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodChecks whether the document contains any tags that can be entered or changed in the tags input dialog. (Inherited from C1.C1Preview.C1PrintDocument)
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodIndicates whether an inline paragraph is currently being created on the document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Loads the current document from a stream. The stream should contain a document in C1.C1Preview.C1DocumentFormatEnum.C1d format. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodBegins a new column. If the current column is the last on the page then a new page will be started. Note that AllowNonReflowableDocs property on the document must be set to true for this method to work; otherwise, an exception will occur. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodBegins a new line in inline flow, can be used only if current stacking is inline flow. Note that AllowNonReflowableDocs property on the document must be set to true for this method to work; otherwise, an exception will occur. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Creates a new page and adds it to the document. Note that C1.C1Preview.C1PrintDocument.AllowNonReflowableDocs property on the document must be set to true for this method to work; otherwise, an exception will occur. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodReturns a System.Drawing.Imaging.Metafile representing the specified page. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Prints the current document with default printer settings, not showing the print progress dialog. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Shows the standard print dialog, allowing the user to print the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodReflows the current document. If a handler has been assigned to the C1.C1Preview.C1PrintDocument.GenerateDocument event, that handler is invoked. Otherwise, the C1.C1Preview.C1PrintDocument.Generate method is called. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodAdds a C1.C1Preview.RenderObject into the block flow of the current document, and resolves it.

    This method can only be used if C1.C1Preview.C1PrintDocument.IsStartEndDocMode is true.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Renders an arc into the block flow of the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Renders an ellipse into the block flow of the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodCreates an internally maintained C1.C1Preview.RenderGraphics object that can be used to add graphics to the block flow of the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodAdds the internally maintained C1.C1Preview.RenderGraphics object created with a previous call to C1.C1Preview.C1PrintDocument.RenderBlockGraphicsBegin to the block flow of the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodRenders a horizontal line with the specified width, starting at the left of the page, into the block flow of the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Renders the Image. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Renders a pie into the block flow of the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Renders a rectangle into the block flow of the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Renders the RTF text. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Renders a block of text into the block flow of the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodRenders a vertical line with the specified height, starting at the current position, into the block flow of the current document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Adds a C1.C1Preview.RenderObject to the C1.C1Preview.C1PrintDocument.Body of the current document at a specific position on the current page, and resolves it.

    This method can only be used if C1.C1Preview.C1PrintDocument.IsStartEndDocMode is true.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Adds an arc to the C1.C1Preview.C1PrintDocument.Body of the current document at a specific position on the current page, and resolves it. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Adds an ellipse to the C1.C1Preview.C1PrintDocument.Body of the current document at a specific position on the current page, and resolves it. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodCreates an internally maintained C1.C1Preview.RenderGraphics object that can be used to add graphics at a specific position to the C1.C1Preview.C1PrintDocument.Body of the document on the current page. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodRenders the internally maintained C1.C1Preview.RenderGraphics object created with a previous call to C1.C1Preview.C1PrintDocument.RenderDirectGraphicsBegin onto the current page of the document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Adds an System.Drawing.Image to the C1.C1Preview.C1PrintDocument.Body of the current document at a specific position on the current page, and resolves it. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Adds a line to the C1.C1Preview.C1PrintDocument.Body of the current document at a specific position on the current page, and resolves it. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Adds a pie to the C1.C1Preview.C1PrintDocument.Body of the current document at a specific position on the current page, and resolves it. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Creates a C1.C1Preview.RenderPolygon from a collection of C1.C1Preview.UnitPoint objects, and renders it on the current page, at position specified by the points' coordinates. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Adds a rectangle to the C1.C1Preview.C1PrintDocument.Body of the current document at a specific position on the current page, and resolves it. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Adds an RTF-formatted string to the C1.C1Preview.C1PrintDocument.Body of the current document at a specific position on the current page, and resolves it. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Adds a text to the C1.C1Preview.C1PrintDocument.Body of the current document at a specific position on the current page, and resolves it. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodRenders a C1.C1Preview.ParagraphObject into the current inline paragraph. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodBegins rendering of a new inline paragraph into the C1.C1Preview.C1PrintDocument.Body of the current document, using the specified C1.C1Preview.C1PrintDocument.Style and dimensions. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodEnds rendering of the current inline paragraph. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Renders an System.Drawing.Image into the current inline paragraph. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Renders a string into the current inline paragraph, using the specified style. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Saves the current document to a disk file. The persistense format (C1.C1Preview.C1DocumentFormatEnum.C1d or C1.C1Preview.C1DocumentFormatEnum.C1dx) is determined by the specified file extension. The save format defaults to C1.C1Preview.C1DocumentFormatEnum.C1d if the format cannot be determined from the extension. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodStarts a new document. (Inherited from C1.C1Preview.C1PrintDocument)
    Public MethodOverloaded. Converts a double value expressed in specified C1.C1Preview.UnitTypeEnum units to a double value expressed in the current document's C1.C1Preview.C1PrintDocument.ResolvedUnit units. (Inherited from C1.C1Preview.C1PrintDocument)
    Public Method (Inherited from System.ComponentModel.Component)
    Top
    Protected Methods
     NameDescription
    Protected MethodCalled when the document has finished generating. Executes the C1.C1Preview.C1PrintDocument.DocumentEndedScript script. See remarks in C1.C1Preview.C1PrintDocument.OnDocumentStarting method for details and order of events. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodOverridden. For internal use.  
    Protected Method (Inherited from System.ComponentModel.Component)
    Protected Method (Inherited from System.ComponentModel.Component)
    Protected MethodPerforms some initializations: creates the sub-objects (PageHeader, PageFooter etc) initializes DefaultPageSettings and so on. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodOverloaded.  (Inherited from System.MarshalByRefObject)
    Protected MethodCalled when the C1.C1Preview.C1PrintDocument.Pages collection is about to be cleared. Raises the C1.C1Preview.C1PrintDocument.BeforePagesClear event. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodCalled when the C1.C1Preview.C1PrintDocument.BusyState property value has changed. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodCalled when the C1.C1Preview.C1PrintDocument.DefaultUnit property value has changed. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodCalled when the document has finished generating. Raises the C1.C1Preview.C1PrintDocument.DocumentEnded event. The C1.C1Preview.C1PrintDocument.BusyState property is set to C1.C1Preview.BusyStateEnum.Ready before this method is called. See remarks in C1.C1Preview.C1PrintDocument.OnDocumentStarting method for more details. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodCalled when the document is starting to generate. Raises the C1.C1Preview.C1PrintDocument.DocumentStarting event. The C1.C1Preview.C1PrintDocument.BusyState property is set to C1.C1Preview.BusyStateEnum.Generating after this method returns. See remarks for more details. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodRaises the C1.C1Preview.C1PrintDocument.FormsStyleChanged event. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodRaises the C1.C1Preview.C1PrintDocument.GenerateDocument event. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodCalled during document generation after a C1.C1Preview.C1Page has completely generated, raises the C1.C1Preview.C1PrintDocument.PageAdded event. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodCalled when a new empty page is created and added to the current document, raises the C1.C1Preview.C1PrintDocument.PageConfigure event. When this method is called, the C1.C1Preview.C1Page has already been added to the C1.C1Preview.C1PrintDocument.Pages collection but has not yet been resolved. If overridden in a derived class, must call the base method; can be used to change the layout of the new page. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodCalled when a page is removed from the C1.C1Preview.C1PrintDocument.Pages collection. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodCalled after the C1.C1Preview.C1PrintDocument.Pages collection has been cleared. Raises the C1.C1Preview.C1PrintDocument.PagesClear event. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodCalled during document generation after a C1.C1Preview.C1Page has updated, raises the C1.C1Preview.C1PrintDocument.PageUpdated event.

    This method is called each time a C1.C1Preview.RenderObject's fragment (C1.C1Preview.RenderFragment) is added to or removed from the page (i.e. this method is called very often while the document generates).

    See also C1.C1Preview.C1PrintDocument.OnPageChanged.

    (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodCalled when the C1.C1Preview.C1PrintDocument.ResolvedUnit property value has changed. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodIndicates whether the C1.C1Preview.C1PrintDocument.AutoEmbedFonts property should be serialized. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodIndicates whether the C1.C1Preview.C1PrintDocument.Style property should be serialized. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodIndicates whether the C1.C1Preview.C1PrintDocument.TagCloseParen property should be serialized. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodIndicates whether the C1.C1Preview.C1PrintDocument.TagEscapeString property should be serialized. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodIndicates whether the C1.C1Preview.C1PrintDocument.TagOpenParen property should be serialized. (Inherited from C1.C1Preview.C1PrintDocument)
    Protected MethodIndicates whether the C1.C1Preview.C1PrintDocument.TagsInputDialogClassName property should be serialized. (Inherited from C1.C1Preview.C1PrintDocument)
    Top
    Public Events
     NameDescription
    Public EventOccurs when the Pages collection is about to be cleared. (Inherited from C1.C1Preview.C1PrintDocument)
    Public EventOccurs when the C1.C1Preview.C1PrintDocument.BusyState property value has changed. (Inherited from C1.C1Preview.C1PrintDocument)
    Public EventOccurs when the C1.C1Preview.C1PrintDocument.DefaultUnit property value has changed. (Inherited from C1.C1Preview.C1PrintDocument)
    Public Event (Inherited from System.ComponentModel.Component)
    Public EventOccurs when the document generation completes. (Inherited from C1.C1Preview.C1PrintDocument)
    Public EventOccurs when the document generation is starting. (Inherited from C1.C1Preview.C1PrintDocument)
    Public EventOccurs when the FormsStyle property value changes. (Inherited from C1.C1Preview.C1PrintDocument)
    Public EventOccurs when the document needs to be generated. Allows user to build the document content in an event handler. (Inherited from C1.C1Preview.C1PrintDocument)
    Public EventOccurs when the value of a RenderInputBase object within the document has been changed. (Inherited from C1.C1Preview.C1PrintDocument)
    Public EventOccurs periodically during document generation. Allows to provide progress indication and the ability to cancel generation to the user. (Inherited from C1.C1Preview.C1PrintDocument)
    Public EventOccurs during document generation when a page has been generated and added to the Pages collection, and the next page is about to be generated. (Inherited from C1.C1Preview.C1PrintDocument)
    Public EventOccurs when an already generated page of the document has been changed, for example when the PageCount variable on the page needs to be updated. (Inherited from C1.C1Preview.C1PrintDocument)
    Public EventOccurs when a new empty page has been created and added to the document's Pages collection, but has not been resolved yet. Use this method only to change the layout of the page. (Inherited from C1.C1Preview.C1PrintDocument)
    Public EventOccurs when the page has been removed from the document's Pages collection. This event cannot fire during document generation. (Inherited from C1.C1Preview.C1PrintDocument)
    Public EventOccurs when the Pages collection has been cleared. (Inherited from C1.C1Preview.C1PrintDocument)
    Public EventOccurs when a page of the document has been updated. Fires very often during document generation when fragments of objects are added to, or removed from the page. (Inherited from C1.C1Preview.C1PrintDocument)
    Public EventOccurs when the C1.C1Preview.C1PrintDocument.ResolvedUnit property value has changed. (Inherited from C1.C1Preview.C1PrintDocument)
    Top
    See Also