Reports for WinForms | ComponentOne
C1.C1Report.4 Assembly / C1.C1Preview Namespace / C1PrintDocument Class


In This Topic
    C1PrintDocument Class Methods
    In This Topic

    For a list of all members of this type, see C1PrintDocument members.

    Public Methods
     NameDescription
    Public MethodAddAnchorOverloaded. Adds an anchor (C1Anchor or C1AnchorText) at the current position in the document. Can be used only if IsStartEndDocMode is true.  
    Public MethodAdvanceBlockFlowAdvances the current block flow position by the specified distance.  
    Public MethodCanRenderBlockIndicates whether rendering in the block flow is permitted now.  
    Public MethodCanRenderDirectIndicates whether direct rendering is permitted now.  
    Public MethodClearClears the current document, sets all properties to their default values.  
    Public MethodClearGeneratedPagesClears the pages and other info created during document generation. This method does not clear the document structure/content though.  
    Public MethodConvertUnitOverloaded. Converts an absolute Unit value to the specified measurement units (this overload cannot convert to pixels).  
    Public MethodCreateObjRef (Inherited from System.MarshalByRefObject)
    Public MethodDisposeOverloaded. Overridden. Releases the resoureces used by C1PrintDocument.  
    Public MethodEditTagsShows the tags input dialog, allows the user to enter/update the values of Tag objects contained in the Tags collection.  
    Public MethodEndDocFinishes generation of a document.  
    Public MethodExportOverloaded. Exports the document to a disk file.  
    Public MethodFindAnchorSearches for an C1Anchor with the specified Name in the current document.  
    Public MethodFindInputFragmentSearches for the first occurrence of a RenderInputFragment object in the current document.  
    Public Methodstatic (Shared in Visual Basic)FromC1ReportCreates a new instance of the C1PrintDocument class representing the specified C1.C1Report.C1Report.  
    Public Methodstatic (Shared in Visual Basic)FromFileOverloaded. Creates a new instance of the C1PrintDocument class, and loads the document from the specified file.  
    Public Methodstatic (Shared in Visual Basic)FromRdlCreates a new instance of the C1PrintDocument class, and imports a RDL report definition into created document.  
    Public MethodFromRUOverloaded. Converts a double value expressed in the current document's ResolvedUnit units to other UnitTypeEnum units.  
    Public Methodstatic (Shared in Visual Basic)FromStreamOverloaded. Creates a new instance of C1PrintDocument class, and loads the document from the specified stream.  
    Public MethodGenerateOverloaded. Generates the current document, using the RefreshModeEnum.RefreshCalculatedValues refresh mode.  
    Public Methodstatic (Shared in Visual Basic)GetLengthAbsValueOverloaded. Converts an absolute length represented by a LengthAbs object to a double value expressed in the current document's ResolvedUnit units.  
    Public MethodGetLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodHasEditableTagsChecks whether the document contains any tags that can be entered or changed in the tags input dialog.  
    Public MethodImportC1ReportImports a C1.C1Report.C1Report report definition into the current document.  
    Public MethodImportRdlImports a RDL report definition into the current document.  
    Public MethodInitializeLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodIsInlineStartedIndicates whether an inline paragraph is currently being created on the document.  
    Public MethodLoadOverloaded. Loads the current document from a stream. The stream should contain a document in C1DocumentFormatEnum.C1d format.  
    Public MethodNewColumnBegins 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.  
    Public MethodNewLineBegins 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.  
    Public MethodNewPageOverloaded. Creates a new page and adds it to the document. Note that AllowNonReflowableDocs property on the document must be set to true for this method to work; otherwise, an exception will occur.  
    Public MethodPageAsMetafileReturns a System.Drawing.Imaging.Metafile representing 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 MethodReflowReflows the current document. If a handler has been assigned to the GenerateDocument event, that handler is invoked. Otherwise, the Generate method is called.  
    Public MethodRenderBlockAdds a RenderObject into the block flow of the current document, and resolves it.

    This method can only be used if IsStartEndDocMode is true.

     
    Public MethodRenderBlockArcOverloaded. Renders an arc into the block flow of the current document.  
    Public MethodRenderBlockEllipseOverloaded. Renders an ellipse into the block flow of the current document.  
    Public MethodRenderBlockGraphicsBeginCreates an internally maintained RenderGraphics object that can be used to add graphics to the block flow of the current document.  
    Public MethodRenderBlockGraphicsEndAdds the internally maintained RenderGraphics object created with a previous call to RenderBlockGraphicsBegin to the block flow of the current document.  
    Public MethodRenderBlockHorzLineRenders a horizontal line with the specified width, starting at the left of the page, into the block flow of the current document.  
    Public MethodRenderBlockImageOverloaded. Renders the Image.  
    Public MethodRenderBlockPieOverloaded. Renders a pie into the block flow of the current document.  
    Public MethodRenderBlockRectangleOverloaded. Renders a rectangle into the block flow of the current document.  
    Public MethodRenderBlockRichTextOverloaded. Renders the RTF text.  
    Public MethodRenderBlockTextOverloaded. Renders a block of text into the block flow of the current document.  
    Public MethodRenderBlockVertLineRenders a vertical line with the specified height, starting at the current position, into the block flow of the current document.  
    Public MethodRenderDirectOverloaded. Adds a RenderObject to the Body of the current document at a specific position on the current page, and resolves it.

    This method can only be used if IsStartEndDocMode is true.

     
    Public MethodRenderDirectArcOverloaded. Adds an arc to the Body of the current document at a specific position on the current page, and resolves it.  
    Public MethodRenderDirectEllipseOverloaded. Adds an ellipse to the Body of the current document at a specific position on the current page, and resolves it.  
    Public MethodRenderDirectGraphicsBeginCreates an internally maintained RenderGraphics object that can be used to add graphics at a specific position to the Body of the document on the current page.  
    Public MethodRenderDirectGraphicsEndRenders the internally maintained RenderGraphics object created with a previous call to RenderDirectGraphicsBegin onto the current page of the document.  
    Public MethodRenderDirectImageOverloaded. Adds an System.Drawing.Image to the Body of the current document at a specific position on the current page, and resolves it.  
    Public MethodRenderDirectLineOverloaded. Adds a line to the Body of the current document at a specific position on the current page, and resolves it.  
    Public MethodRenderDirectPieOverloaded. Adds a pie to the Body of the current document at a specific position on the current page, and resolves it.  
    Public MethodRenderDirectPolygonOverloaded. Creates a RenderPolygon from a collection of UnitPoint objects, and renders it on the current page, at position specified by the points' coordinates.  
    Public MethodRenderDirectRectangleOverloaded. Adds a rectangle to the Body of the current document at a specific position on the current page, and resolves it.  
    Public MethodRenderDirectRichTextOverloaded. Adds an RTF-formatted string to the Body of the current document at a specific position on the current page, and resolves it.  
    Public MethodRenderDirectTextOverloaded. Adds a text to the Body of the current document at a specific position on the current page, and resolves it.  
    Public MethodRenderInlineRenders a ParagraphObject into the current inline paragraph.  
    Public MethodRenderInlineBeginBegins rendering of a new inline paragraph into the Body of the current document, using the specified Style and dimensions.  
    Public MethodRenderInlineEndEnds rendering of the current inline paragraph.  
    Public MethodRenderInlineImageOverloaded. Renders an System.Drawing.Image into the current inline paragraph.  
    Public MethodRenderInlineTextOverloaded. Renders a string into the current inline paragraph, using the specified style.  
    Public MethodSaveOverloaded. Saves the current document to a disk file. The persistense format (C1DocumentFormatEnum.C1d or C1DocumentFormatEnum.C1dx) is determined by the specified file extension. The save format defaults to C1DocumentFormatEnum.C1d if the format cannot be determined from the extension.  
    Public Methodstatic (Shared in Visual Basic)SelectBestMeasurementDeviceSelects a device to use for MeasurementGraphics. This method looks for a printer with a "square" resolution (i.e. with the same horizontal and vertical DPI) equal to or larger than 300 DPI. If such a printer is found, it is assigned to MeasurementPrinterName, and MeasurementDevice is set to MeasurementDeviceEnum.Printer. Otherwise, MeasurementDevice is set to MeasurementDeviceEnum.Screen. The selected device's resolution is returned by MeasurementDpi.  
    Public MethodStartDocStarts a new document.  
    Public MethodToRUOverloaded. Converts a double value expressed in specified UnitTypeEnum units to a double value expressed in the current document's ResolvedUnit units.  
    Public MethodToString (Inherited from System.ComponentModel.Component)
    Top
    Protected Methods
     NameDescription
    Protected MethodExecuteDocumentEndedScriptCalled when the document has finished generating. Executes the DocumentEndedScript script. See remarks in OnDocumentStarting method for details and order of events.  
    Protected MethodExecuteDocumentStartingScriptCalled when the document is starting to generate. Executes the DocumentStartingScript script. See remarks in OnDocumentStarting method for details and order of events.  
    Protected MethodFinalize (Inherited from System.ComponentModel.Component)
    Protected MethodGetService (Inherited from System.ComponentModel.Component)
    Protected MethodInitDocumentPerforms some initializations: creates the sub-objects (PageHeader, PageFooter etc) initializes DefaultPageSettings and so on.  
    Protected MethodMemberwiseCloneOverloaded.  (Inherited from System.MarshalByRefObject)
    Protected MethodOnBeforePagesClearCalled when the Pages collection is about to be cleared. Raises the BeforePagesClear event.  
    Protected MethodOnBusyStateChangedCalled when the BusyState property value has changed.  
    Protected MethodOnDefaultUnitChangedCalled when the DefaultUnit property value has changed.  
    Protected MethodOnDocumentEndedCalled when the document has finished generating. Raises the DocumentEnded event. The BusyState property is set to BusyStateEnum.Ready before this method is called. See remarks in OnDocumentStarting method for more details.  
    Protected MethodOnDocumentStartingCalled when the document is starting to generate. Raises the DocumentStarting event. The BusyState property is set to BusyStateEnum.Generating after this method returns. See remarks for more details.  
    Protected MethodOnFormsStyleChangedRaises the FormsStyleChanged event.  
    Protected MethodOnGenerateDocumentRaises the GenerateDocument event.  
    Protected MethodOnPageAddedCalled during document generation after a C1Page has completely generated, raises the PageAdded event.  
    Protected MethodOnPageConfigureCalled when a new empty page is created and added to the current document, raises the PageConfigure event. When this method is called, the C1Page has already been added to the 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.  
    Protected MethodOnPageDeletedCalled when a page is removed from the Pages collection.  
    Protected MethodOnPagesClearCalled after the Pages collection has been cleared. Raises the PagesClear event.  
    Protected MethodOnPageUpdatedCalled during document generation after a C1Page has updated, raises the PageUpdated event.

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

    See also OnPageChanged.

     
    Protected MethodOnResolvedUnitChangedCalled when the ResolvedUnit property value has changed.  
    Protected MethodShouldSerializeAutoEmbedFontsIndicates whether the AutoEmbedFonts property should be serialized.  
    Protected MethodShouldSerializeStyleIndicates whether the Style property should be serialized.  
    Protected MethodShouldSerializeTagCloseParenIndicates whether the TagCloseParen property should be serialized.  
    Protected MethodShouldSerializeTagEscapeStringIndicates whether the TagEscapeString property should be serialized.  
    Protected MethodShouldSerializeTagOpenParenIndicates whether the TagOpenParen property should be serialized.  
    Protected MethodShouldSerializeTagsInputDialogClassNameIndicates whether the TagsInputDialogClassName property should be serialized.  
    Top
    See Also

    Reference

    C1PrintDocument Class
    C1.C1Preview Namespace