[]
        
(Showing Draft Content)

C1.C1Preview.C1PrintDocument

C1PrintDocument Class

Represents a ComponentOne Document.

Inheritance
C1PrintDocument
Namespace: C1.C1Preview
Assembly: C1.PrintDocument.8.dll
Syntax
[ToolboxBitmap(typeof(C1PrintDocument), "C1PrintDocument.png")]
[C1OpenXmlSerialization("/document/document.xml")]
public class C1PrintDocument : Component, IComponent, IDisposable, IStyleOwner, IDocumentLocation, ISupportInitialize

Constructors

Name Description
C1PrintDocument()

Initializes a new instance of the C1PrintDocument class.

Properties

Name Description
AcceptButton

Gets the RenderInputButton object representing the accept button in the current document (the first RenderInputButton object with AcceptButton property set to true).

ActualCreationDevice

Gets the actual measurement device which was used to generate the document. This device can differ from the one specified by CreationDevice, for example if CreationDevice was set to Printer but the current system has no printers installed.

ActualCreationPrinterName

Gets the name of the actual measurement printer which was used to generate the document. This can differ from the name specified by CreationPrinterName, for example if the report was rendered on a system with no such printer.

AddWarningsWhenErrorInScript

Gets or sets a value indicating whether to add messages to the current document's Warnings collection when script errors are found.

The default value is false.

AllowNonReflowableDocs

Gets 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 NewPage()). If this property is false, calling such methods throws an exception. If this property is true, calling such methods sets the Reflowable flag to false on the current document.

The default value is false.

AssemblyVersion

Gets the version of C1PrintDocument assembly.

AutoEmbedFonts

This property is obsolete.

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

The default value is false.

AvailableBlockFlowHeight

An 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.

AvailableBlockFlowWidth

An 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.

Body

Gets the DocumentBody object representing the body of the current document.

BuildSerializerLog

Gets or sets a value indicating whether a log should be built during serialization and deserialization operations. If an exception occurs, that log is available in the exception data. Set this property to true to help debugging obscure serialization errors.

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.

ClipPage

Gets or sets a value indicating whether to clip the content of the current document to page margins.

The default value is false.

CompatibilityOptions

Gets the CompatibilityOptions object which determines compatibility with previous versions of C1PrintDocument.

CreationDevice

Gets or sets the type of device that is used to provide reference graphics when generating the document. If this property is set to Printer, CreationPrinterName specifies the printer.

CreationDpi

Gets or sets the resolution (DPI) used when generating the document.

Note that if ResolvedUnit is Pixel, this is also the resolution of ResolvedUnit pixels.

CreationGraphics

Gets or sets the Graphics object to use as reference when generating the report. This Graphics is used to calculate text sizes, measure RTF text, and so on.

CreationMode

Gets the document creation mode.

CreationPrinterName

Gets or sets the name of the printer that is used to provide reference graphics when generating the document.

This property is only used if CreationDevice is set to Printer.

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

CurrentBlockGraphics

Gets the current Graphics object created by the last call to RenderBlockGraphicsBegin().

CurrentBlockRenderGraphics

Gets the current RenderGraphics object created by the last call to RenderBlockGraphicsBegin().

CurrentDirectGraphics

Gets the current Graphics object created by the last call to RenderDirectGraphicsBegin(Unit, Unit).

CurrentDirectRenderGraphics

Gets the current RenderGraphics object created by the last call to RenderDirectGraphicsBegin(Unit, Unit).

CurrentPage

Gets the current generating page, returns null if document in not generating state.

CurrentPageArea

Gets the current generating area of page, returns null if document in not generating state.

CurrentPageLayout

Gets 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 PageLayouts. You may change the properties on CurrentPageLayout programmatically. The changes will be effective immediately if they are made in the 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.

DataSchema

Gets the C1DataSchema object representing the data schema built into the current document.

DefaultUnit

Gets 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 Inch.

Dictionary

Gets the current document's Dictionary. The Dictionary can be used to contain reused resources (e.g. images used in multiple places in the document).

DisableUserReflow

Gets 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).

DoEvents

Gets or sets a value indicating whether the current C1PrintDocument should handle Windows messages while generating.

The default value is false.

Document

Gets a 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.

DocumentDirectoryName

Gets the directory of the DocumentFileName.

DocumentEndedScript

Gets or sets the script that is executed when the current document has finished generating.

DocumentFileName

Gets the file name associated with the current document (i.e. the document was either loaded from that file, or saved to it).

DocumentFonts

Gets the collection of DocumentFont objects describing fonts used in the current document.

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

DocumentFormatVersion

Gets a string representing the version of the document persistence format supported by the current assembly. This version is used to check persisted documents' compatibility. Versions are backwards-compatible, but not vice versa (i.e. a document persisted using a newer version of C1PrintDocument may be unreadable by an older version).

DocumentInfo

Gets or sets the DocumentInfo object containing the information about the current document (such as author, company, and so on).

DocumentStartingScript

Gets or sets the script that is executed when the current document starts generating.

EmbeddedFonts

Gets the collection of fonts embedded in the current document.

If FontHandling property on the document has been set to EmbedFonts or 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 AddGlyphs(string) method or any of its overloads.

EmfType

Gets or sets the type of metafiles created by the current document. The default is EmfPlusOnly.

ErrorCode

Obsolete. Now gets the Code of the first element in the Warnings collection, or GenerateErrorEnum.None if there are no warnings.

ErrorDesc

Obsolete. Now gets the description of the first element in the Warnings collection, or an empty string if there are no warnings.

ErrorScript

Gets or sets the script that is executed when an error occurs in a script attached to the current document.

ExportProviders

Gets the collection of all registered ExportProvider objects.

FontHandling

Gets or sets a value specifying how font embedding and substitution are handled by the current C1PrintDocument. This property is simply a shortcut to FontHandling.

FontProcessingOptions

Gets the FontProcessingOptions object which determines how font subtitution and embedding are handled when the document generates.

FormatVersion

Gets a C1.C1Preview.C1FormatVersion object representing the version of the document persistence format supported by the current assembly. This version is used to check persisted documents' compatibility. Versions are backwards-compatible, but not vice versa (i.e. a document persisted using a newer version of C1PrintDocument may be unreadable by an older version).

FormsKeyActionEnter

Gets 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 None.

FormsKeyActionTab

Gets 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 MoveAccrossDocOut.

FormsStyle

Gets or sets a FormsStyleEnum value specifying the look and feel of input controls in the current document (see types derived from RenderInputBase).

The default value is Acrobat.

GeneratingComplete

If the current document is generating (see IsGenerating), gets the approximate completion ratio, from 0 (0% complete) to 1 (100% complete). If the document is currently not generating, gets 1.

HasGenerateDocumentHandler

Gets the value indicating whether a handler is attached to the GenerateDocument event of the current document.

IsGenerating

Indicates whether the document is currently being generated.

IsPageCountFinal

Gets 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 IsGenerating), gets true.

IsStartEndDocMode

Gets a value indicating whether the document is being generated via StartDoc() / EndDoc() methods.

MaxPages

Gets 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 Generate() method.

MeasurementDevice

Gets or sets the type of device used to provide Graphics used to measure/calculate layouts of C1PrintDocument objects. If this property is set to Printer, MeasurementPrinterName specifies the printer.

MeasurementDpi

Gets the resolution (DPI) of the MeasurementGraphics object.

MeasurementGraphics

Gets the Graphics object used to measure/calculate layouts of C1PrintDocument objects.

MeasurementPrinterName

Gets or sets the name of the printer used to provide Graphics used to measure/calculate layouts of C1PrintDocument objects. This property is only used if MeasurementDevice is set to Printer.

Outlines

Gets the OutlineNodeCollection representing the collection of OutlineNode objects of the current document.

PageConfigureScript

Gets 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 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.

PageLayout

Gets or sets the default page layout for the current document. This property is a shortcut for Default. (A page layout includes page settings, page headers and footers, and column definitions.)

PageLayouts

Gets 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.

PageNumberingChange

Gets or sets the PageNumberingChange object applied to the first page of the document.

Pages

Gets the collection of document's pages.

Reflowable

Gets a value indicating whether the document is reflowable.

ResolvedUnit

Gets or sets the UnitTypeEnum value that will be used to specify the resolved sizes of objects within the current document (e.g. the sizes of RenderFragment objects representing the render objects in the document).

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

ScriptingOptions

Gets the ScriptingOptions object defining the scripting options of this C1PrintDocument object.

ShowTagsInputDialog

Gets or sets a value indicating whether a dialog allowing to input values for some or all of the user defined tags (elements of the Tags collection) should be shown to the user before the document generates. To include or exclude tags from the dialog, use ShowInDialog.

The default value is false.

Stacking

Gets or sets the top-level stacking rule for the document body.

The default value is BlockTopToBottom.

Style

Gets the main (root) Style of the current document.

SystemTags

Gets the collection of system tags (objects derived from TagSys) associated with the current document.

TagCloseParen

Gets or sets the string used as the closing parentheses when including references to Tag objects in the current document's texts (e.g. in Text or Text). To include a TagCloseParen string itself in a text, prepend it with the TagEscapeString string.

The default value is "]".

TagEscapeString

Gets or sets the string that can be used to escape TagOpenParen and TagCloseParen. To include a TagEscapeString string itself in a text, duplicate it.

The default value is "\".

TagOpenParen

Gets or sets the string used as the opening parentheses when including references to Tag objects in the current document's texts (e.g. in Text or Text). To include a TagOpenParen string itself in a text, prepend it with the TagEscapeString string.

The default value is "[".

Tags

Gets the TagCollection representing the collection of user-defined Tag objects in the current document.

TagsInputDialogClass

Gets or sets the type of form used to input tag values (the form will be shown if ShowTagsInputDialog is true). The form type must be derived from TagsInputFormBase.

TagsInputDialogClassName

Gets or sets the type name of form used to input tag values (the form will be shown if ShowTagsInputDialog is true). The form type must be derived from TagsInputFormBase.

ThrowExceptionOnError

Gets 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 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.

UsageInfo

Gets the 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.

UseGdiPlusTextRendering

Gets or sets a value indicating whether text in the current document should be rendered using the GDI+ text API.

The default value is false.

UsePrinterForDefaultPageSettings

Gets or sets a value indicating whether the default page settings are retrieved from the default printer (may slow things down if the printer is a network one) or calculated based on the current locale.

UserData

Gets or sets arbitrary data associated with the current document.

Warnings

Gets the collection of warnings produced by the document's generation.

Methods

Name Description
AddAnchor(string)

Adds an anchor (C1Anchor or C1AnchorText) at the current position in the document. Can be used only if IsStartEndDocMode is true.

This method is equivalent to AddAnchor(string, string, object) with the last two parameters (description and user data) specified as null values.

AddAnchor(string, string)

Adds an anchor (C1Anchor or C1AnchorText) at the current position in the document. Can be used only if IsStartEndDocMode is true.

This method is equivalent to AddAnchor(string, string, object) with the last parameter (user data) specified as null value.

AddAnchor(string, string, object)

Adds an anchor (C1Anchor or C1AnchorText) at the current position in the document. Can be used only if IsStartEndDocMode is true.

AdvanceBlockFlow(Unit)

Advances the current block flow position by the specified distance.

CanRenderBlock()

Indicates whether rendering in the block flow is permitted now.

CanRenderDirect()

Indicates whether direct rendering is permitted now.

Clear()

Clears the current document, sets all properties to their default values.

ClearGeneratedPages()

Clears the pages and other info created during document generation. This method does not clear the document structure/content though.

ConvertUnit(Unit, UnitTypeEnum)

Converts an absolute Unit value to the specified measurement units (this overload cannot convert to pixels).

ConvertUnit(Unit, UnitTypeEnum, float)

Converts an absolute Unit value to the specified measurement units.

Dispose(bool)

Releases the resoureces used by C1PrintDocument.

EditTags()

Shows the tags input dialog, allows the user to enter/update the values of Tag objects contained in the Tags collection.

EndDoc()

Finishes generation of a document.

ExecuteDocumentEndedScript()

Called when the document has finished generating. Executes the DocumentEndedScript script. See remarks in OnDocumentStarting() method for details and order of events.

ExecuteDocumentStartingScript()

Called when the document is starting to generate. Executes the DocumentStartingScript script. See remarks in OnDocumentStarting() method for details and order of events.

Export(Stream, ExportProvider)

Exports the document to a stream.

Export(Stream, ExportProvider, OutputRange, bool)

Exports the document to a stream.

Export(Stream, ExportProvider, bool)

Exports the document to a stream.

Export(string)

Exports the document to a disk file.

Export(string, ExportProvider, OutputRange, bool)

Exports the document to a disk file.

Export(string, OutputRange, bool)

Exports the document to a disk file.

Export(string, bool)

Exports the document to a disk file.

FindAnchor(string)

Searches for an C1Anchor with the specified Name in the current document.

FindInputFragment(int, bool)

Searches for the first occurrence of a RenderInputFragment object in the current document.

FromFile(string)

Creates a new instance of the C1PrintDocument class, and loads the document from the specified file. The persistence format (C1d or C1dx) is determinated by the file extension. If the format cannot be determined by the extension, the C1d format is used.

FromFile(string, C1DocumentFormatEnum)

Creates a new instance of the C1PrintDocument class, and loads the document from the specified file.

FromRU(OffsetsD, UnitTypeEnum)

Converts a OffsetsD value expressed in the current document's ResolvedUnit units to other UnitTypeEnum units, using CreationDpi resolution if destType is Pixel.

FromRU(OffsetsD, UnitTypeEnum, float, float)

Converts a OffsetsD value expressed in the current document's ResolvedUnit units to other UnitTypeEnum units.

FromRU(OffsetsD, float, float, bool)

Converts a OffsetsD value expressed in the current document's ResolvedUnit units to a Rectangle structure expressed in Pixel units, using the specified resolution.

Depending on the truncate parameter, the converted value is either simply truncated, or rounded (slower but more precise).

FromRU(PointD, UnitTypeEnum, float, float)

Converts a PointD value expressed in the current document's ResolvedUnit units to other UnitTypeEnum units.

FromRU(RectangleD, UnitTypeEnum)

Converts a RectangleD value expressed in the current document's ResolvedUnit units to other UnitTypeEnum units, using CreationDpi resolution if destType is Pixel.

FromRU(RectangleD, UnitTypeEnum, float, float)

Converts a RectangleD value expressed in the current document's ResolvedUnit units to other UnitTypeEnum units.

FromRU(RectangleD, float, float, bool)

Converts a RectangleD value expressed in the current document's ResolvedUnit units to a Rectangle structure expressed in Pixel units, using the specified resolution.

Depending on the truncate parameter, the converted value is either simply truncated, or rounded (slower but more precise).

FromRU(double, UnitTypeEnum)

Converts a double value expressed in the current document's ResolvedUnit units to other UnitTypeEnum units, using CreationDpi resolution if destType is Pixel.

FromRU(double, UnitTypeEnum, float)

Converts a double value expressed in the current document's ResolvedUnit units to other UnitTypeEnum units.

FromRU(double, float, bool)

Converts a double value expressed in the current document's ResolvedUnit units to Pixel units with resolution specified by destDpi.

Depending on the truncate parameter, the converted value is either simply truncated, or rounded (slower but more precise).

FromRU(Region, UnitTypeEnum, float, float)

Transforms (scales) a Region object expressed in the current document's ResolvedUnit units so that it uses other UnitTypeEnum units.

FromStream(Stream)

Creates a new instance of the C1PrintDocument class, and loads the document from the specified stream. The stream must contain a document in the C1d format.

FromStream(Stream, C1DocumentFormatEnum)

Creates a new instance of C1PrintDocument class, and loads the document from the specified stream.

Generate()

Generates the current document, using the RefreshCalculatedValues refresh mode.

Generate(RefreshModeEnum)

Generates the current document. Depending on the specified refresh mode, may update data-bound and calculated values.

GetLengthAbsValue(LengthAbs, Style, IScriptContext)

Converts an absolute length represented by a C1.C1Preview.LengthAbs object to a double value expressed in the current document's ResolvedUnit units.

GetLengthAbsValue(LengthAbs, Font)

Converts an absolute length represented by a C1.C1Preview.LengthAbs object to a double value expressed in the current document's ResolvedUnit units.

HasEditableTags()

Checks whether the document contains any tags that can be entered or changed in the tags input dialog.

InitDocument()

Performs some initializations: creates the sub-objects (PageHeader, PageFooter etc) initializes DefaultPageSettings and so on.

IsInlineStarted()

Indicates whether an inline paragraph is currently being created on the document.

Load(Stream)

Loads the current document from a stream. The stream should contain a document in C1d format.

Load(Stream, C1DocumentFormatEnum)

Loads the current document from a stream.

Load(string)

Loads the current document from a file. The persistence format (C1d or C1dx) is determined by the file extension. The format defaults to C1d if the format cannot be determined from the extension.

Load(string, C1DocumentFormatEnum)

Loads the current document from a file.

NewColumn()

Begins 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.

NewLine()

Begins 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.

NewPage()

Creates a new page and adds it to the document.

NewPage(PageLayout)

Creates a new page and adds it to the document.

NewPage(PageLayout, PageDirectionEnum)

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.

OnBeforePagesClear()

Called when the Pages collection is about to be cleared. Raises the BeforePagesClear event.

OnBusyStateChanged()

Called when the BusyState property value has changed.

OnDefaultUnitChanged()

Called when the DefaultUnit property value has changed.

OnDocumentEnded()

Called when the document has finished generating. Raises the DocumentEnded event. The BusyState property is set to Ready before this method is called. See remarks in OnDocumentStarting() method for more details.

OnDocumentStarting()

Called when the document is starting to generate. Raises the DocumentStarting event. The BusyState property is set to Generating after this method returns. See remarks for more details.

OnFormsStyleChanged()

Raises the FormsStyleChanged event.

OnGenerateDocument()

Raises the GenerateDocument event.

OnInputValueChanged(RenderInputBase)

Called when the C1.C1Preview.IValueProvider.Value property of a RenderInputBase object contained in the current document has changed. Raises the InputValueChanged event.

OnLongOperation(double, bool)

Called to indicate the progress of document generating.

OnPageAdded(C1Page)

Called during document generation after a C1Page has completely generated, raises the PageAdded event.

OnPageChanged(C1Page)

Called during document generation after a C1Page that has already been added to the document has changed (e.g. if page numbering is changed, or the PageCount tag used on the page is updated), raises the PageChanged event.

See also OnPageUpdated(C1Page).

OnPageConfigure(C1Page)

Called 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.

OnPageDeleted(C1Page)

Called when a page is removed from the Pages collection.

OnPageUpdated(C1Page)

Called 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(C1Page).

OnPagesClear()

Called after the Pages collection has been cleared. Raises the PagesClear event.

OnResolvedUnitChanged()

Called when the ResolvedUnit property value has changed.

PageAsMetafile(int)

Returns a Metafile representing 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 of the current document with specified printer settings, not showing the print progress dialog.

Print(PrinterSettings, OutputRange, bool)

Prints a range of pages of the current document with specified printer settings, optionally showing the print progress dialog.

Print(PrinterSettings, bool)

Prints the document with specified printer settings, optionally showing the print progress dialog.

Print(PrinterSettings, PageSettings, OutputRange)

Prints a range of pages of 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 of 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.

Reflow()

Reflows the current document. If a handler has been assigned to the GenerateDocument event, that handler is invoked. Otherwise, the Generate() method is called.

RenderBlock(RenderObject)

Adds a RenderObject into the block flow of the current document, and resolves it.

This method can only be used if IsStartEndDocMode is true.

RenderBlockArc(Unit, Unit, float, float, LineDef)

Renders an arc into the block flow of the current document.

RenderBlockArc(Unit, Unit, float, float, LineDef, Brush)

Renders an arc into the block flow of the current document.

RenderBlockArc(Unit, Unit, float, float, LineDef, Color)

Renders an arc into the block flow of the current document.

RenderBlockArc(Unit, Unit, float, float, Style)

Renders an arc into the block flow of the current document.

RenderBlockArc(Unit, Unit, float, float, Color, Unit)

Renders an arc into the block flow of the current document.

RenderBlockArc(Unit, Unit, float, float, Color, Unit, Color)

Renders an arc into the block flow of the current document.

RenderBlockEllipse(Unit, Unit, LineDef)

Renders an ellipse into the block flow of the current document.

RenderBlockEllipse(Unit, Unit, LineDef, Brush)

Renders an ellipse into the block flow of the current document.

RenderBlockEllipse(Unit, Unit, LineDef, Color)

Renders an ellipse into the block flow of the current document.

RenderBlockEllipse(Unit, Unit, Style)

Renders an ellipse into the block flow of the current document.

RenderBlockEllipse(Unit, Unit, Color, Unit)

Renders an ellipse into the block flow of the current document.

RenderBlockEllipse(Unit, Unit, Color, Unit, Color)

Renders an ellipse into the block flow of the current document.

RenderBlockGraphicsBegin()

Creates an internally maintained RenderGraphics object that can be used to add graphics to the block flow of the current document.

RenderBlockGraphicsEnd()

Adds the internally maintained RenderGraphics object created with a previous call to RenderBlockGraphicsBegin() to the block flow of the current document.

RenderBlockHorzLine(Unit, LineDef)

Renders a horizontal line with the specified width, starting at the left of the page, into the block flow of the current document.

RenderBlockImage(Image)

Renders the Image.

RenderBlockImage(Image, object, object, ImageAlign)

Renders the Image.

RenderBlockImage(Image, object, object, Style)

Renders the Image.

RenderBlockPie(Unit, Unit, float, float, LineDef)

Renders a pie into the block flow of the current document.

RenderBlockPie(Unit, Unit, float, float, LineDef, Brush)

Renders a pie into the block flow of the current document.

RenderBlockPie(Unit, Unit, float, float, LineDef, Color)

Renders a pie into the block flow of the current document.

RenderBlockPie(Unit, Unit, float, float, Style)

Renders a pie into the block flow of the current document.

RenderBlockPie(Unit, Unit, float, float, Color, Unit)

Renders a pie into the block flow of the current document.

RenderBlockPie(Unit, Unit, float, float, Color, Unit, Color)

Renders a pie into the block flow of the current document.

RenderBlockRectangle(Unit, Unit, LineDef)

Renders a rectangle into the block flow of the current document.

RenderBlockRectangle(Unit, Unit, LineDef, Brush)

Renders a rectangle into the block flow of the current document.

RenderBlockRectangle(Unit, Unit, LineDef, Color)

Renders a rectangle into the block flow of the current document.

RenderBlockRectangle(Unit, Unit, Style)

Renders a rectangle into the block flow of the current document.

RenderBlockRectangle(Unit, Unit, Color, Unit)

Renders a rectangle into the block flow of the current document.

RenderBlockRectangle(Unit, Unit, Color, Unit, Color)

Renders a rectangle into the block flow of the current document.

RenderBlockRichText(string)

Renders the RTF text with parent width and autoheight.

RenderBlockRichText(string, object)

Renders the RTF text with autoheight.

RenderBlockRichText(string, object, object, Style)

Renders the RTF text.

RenderBlockText(string)

Renders a block of text into the block flow of the current document.

RenderBlockText(string, AlignHorzEnum)

Renders a block of text into the block flow of the current document, using the specified horizontal alignment.

RenderBlockText(string, Style)

Renders a block of text into the block flow of the current document, using the specified Style.

RenderBlockText(string, Color)

Renders a block of text into the block flow of the current document, using the specified text color.

RenderBlockText(string, Font)

Renders a block of text into the block flow of the current document, using the specified font.

RenderBlockText(string, Font, AlignHorzEnum)

Renders a block of text into the block flow of the current document, using the specified font and horizontal alignment.

RenderBlockText(string, Font, Color)

Renders a block of text into the block flow of the current document, using the specified font and text color.

RenderBlockText(string, Font, Color, AlignHorzEnum)

Renders a block of text into the block flow of the current document, using the specified font, text color and horizontal alignment.

RenderBlockText(string, object, object, Style)

Renders a block of text with the specifed width and height into the block flow of the current document, using the specified Style.

RenderBlockVertLine(Unit, LineDef)

Renders a vertical line with the specified height, starting at the current position, into the block flow of the current document.

RenderDirect(Unit, Unit, RenderObject)

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.

RenderDirect(Unit, Unit, RenderObject, object, object)

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.

RenderDirectArc(Unit, Unit, Unit, Unit, float, float, LineDef)

Adds an arc to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectArc(Unit, Unit, Unit, Unit, float, float, LineDef, Brush)

Adds an arc to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectArc(Unit, Unit, Unit, Unit, float, float, LineDef, Color)

Adds an arc to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectArc(Unit, Unit, Unit, Unit, float, float, Style)

Adds an arc to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectArc(Unit, Unit, Unit, Unit, float, float, Color, Unit)

Adds an arc to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectArc(Unit, Unit, Unit, Unit, float, float, Color, Unit, Color)

Adds an arc to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectEllipse(Unit, Unit, Unit, Unit, LineDef)

Adds an ellipse to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectEllipse(Unit, Unit, Unit, Unit, LineDef, Brush)

Adds an ellipse to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectEllipse(Unit, Unit, Unit, Unit, LineDef, Color)

Adds an ellipse to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectEllipse(Unit, Unit, Unit, Unit, Style)

Adds an ellipse to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectEllipse(Unit, Unit, Unit, Unit, Color, Unit)

Adds an ellipse to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectEllipse(Unit, Unit, Unit, Unit, Color, Unit, Color)

Adds an ellipse to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectGraphicsBegin(Unit, Unit)

Creates 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.

RenderDirectGraphicsEnd()

Renders the internally maintained RenderGraphics object created with a previous call to RenderDirectGraphicsBegin(Unit, Unit) onto the current page of the document.

RenderDirectImage(Unit, Unit, Image)

Adds an Image to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectImage(Unit, Unit, Image, object, object, ImageAlign)

Adds an Image to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectImage(Unit, Unit, Image, object, object, Style)

Adds an Image to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectLine(Unit, Unit, Unit, Unit, LineDef)

Adds a line to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectLine(Unit, Unit, Unit, Unit, Color, Unit)

Adds a line to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectPie(Unit, Unit, Unit, Unit, float, float, LineDef)

Adds a pie to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectPie(Unit, Unit, Unit, Unit, float, float, LineDef, Brush)

Adds a pie to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectPie(Unit, Unit, Unit, Unit, float, float, LineDef, Color)

Adds a pie to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectPie(Unit, Unit, Unit, Unit, float, float, Style)

Adds a pie to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectPie(Unit, Unit, Unit, Unit, float, float, Color, Unit)

Adds a pie to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectPie(Unit, Unit, Unit, Unit, float, float, Color, Unit, Color)

Adds a pie to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectPolygon(IEnumerable, LineDef)

Creates an open RenderPolygon from a collection of UnitPoint objects, and renders it on the current page, at position specified by the points' coordinates.

RenderDirectPolygon(IEnumerable, LineDef, Brush)

Creates a RenderPolygon from a collection of UnitPoint objects, and renders it on the current page, at position specified by the points' coordinates.

If fillBrush is null, the polygon is open, otherwise it is closed.

RenderDirectPolygon(IEnumerable, LineDef, Color)

Creates a RenderPolygon from a collection of UnitPoint objects, and renders it on the current page, at position specified by the points' coordinates.

If fillColor specifies a non-empty and non-transparent color, the polygon is closed, otherwise it is open.

RenderDirectPolygon(IEnumerable, bool, Style)

Creates a RenderPolygon from a collection of UnitPoint objects, and renders it on the current page, at position specified by the points' coordinates.

RenderDirectPolygon(IEnumerable, Color, Unit)

Creates an open RenderPolygon from a collection of UnitPoint objects, and renders it on the current page, at position specified by the points' coordinates.

RenderDirectPolygon(IEnumerable, Color, Unit, Color)

Creates a RenderPolygon from a collection of UnitPoint objects, and renders it on the current page, at position specified by the points' coordinates.

If fillColor specifies a non-empty and non-transparent color, the polygon is closed, otherwise it is open.

RenderDirectRectangle(Unit, Unit, Unit, Unit, LineDef)

Adds a rectangle to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectRectangle(Unit, Unit, Unit, Unit, LineDef, Brush)

Adds a rectangle to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectRectangle(Unit, Unit, Unit, Unit, LineDef, Color)

Adds a rectangle to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectRectangle(Unit, Unit, Unit, Unit, Style)

Adds a rectangle to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectRectangle(Unit, Unit, Unit, Unit, Color, Unit)

Adds a rectangle to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectRectangle(Unit, Unit, Unit, Unit, Color, Unit, Color)

Adds a rectangle to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectRichText(Unit, Unit, string, object)

Adds an RTF-formatted string to the Body of the current document at a specific position on the current page with auto height, and resolves it.

RenderDirectRichText(Unit, Unit, string, object, object, Style)

Adds an RTF-formatted string to the Body of the current document at a specific position on the current page, and resolves it.

RenderDirectText(Unit, Unit, string, object, Font, Color, AlignHorzEnum)

Adds a text to the Body of the current document at a specific position on the current page, with auto height, and resolves it.

RenderDirectText(Unit, Unit, string, object, object, Style)

Adds a text to the Body of the current document at a specific position on the current page, and resolves it.

RenderInline(ParagraphObject, object, object, Style)

Renders a ParagraphObject into the current inline paragraph.

RenderInlineBegin(Style, object, object)

Begins rendering of a new inline paragraph into the Body of the current document, using the specified Style and dimensions.

RenderInlineEnd()

Ends rendering of the current inline paragraph.

RenderInlineImage(Image)

Renders an Image into the current inline paragraph.

RenderInlineImage(Image, Style)

Renders an Image into the current inline paragraph, using the specified Style.

RenderInlineText(string)

Renders a string into the current inline paragraph.

RenderInlineText(string, Style)

Renders a string into the current inline paragraph, using the specified style.

RenderInlineText(string, Color)

Renders a string into the current inline paragraph, using the specified text color.

RenderInlineText(string, Font)

Renders a string into the current inline paragraph, using the specified font.

RenderInlineText(string, Font, Color)

Renders a string into the current inline paragraph, using the specified font and text color.

RenderInlineText(string, FontStyle)

Renders a string into the current inline paragraph, using the specified font style.

Save(Stream)

Saves the current document to a stream using the C1d format.

Save(Stream, C1DocumentFormatEnum)

Saves the current document to a stream using the specified format.

Save(string)

Saves the current document to a disk file. The persistense format (C1d or C1dx) is determined by the specified file extension. The save format defaults to C1d if the format cannot be determined from the extension.

Save(string, C1DocumentFormatEnum)

Saves the current document to a disk file using the specified format.

SelectBestMeasurementDevice()

Selects 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 Printer. Otherwise, MeasurementDevice is set to Screen.

The selected device's resolution is returned by MeasurementDpi.

ShouldSerializeAdditionalObjects()

Indicates whether the C1.C1Preview.C1PrintDocument.AdditionalObjects property should be serialized.

ShouldSerializeAutoEmbedFonts()

Indicates whether the AutoEmbedFonts property should be serialized.

ShouldSerializeCompatibilityOptions()

Indicates whether the CompatibilityOptions property should be serialized.

ShouldSerializeDataSchema()

Indicates whether the DataSchema property should be serialized.

ShouldSerializeDocumentEndedScript()

Indicates whether the DocumentEndedScript property should be serialized.

ShouldSerializeDocumentInfo()

Indicates whether the DocumentInfo property should be serialized.

ShouldSerializeDocumentStartingScript()

Indicates whether the DocumentStartingScript property should be serialized.

ShouldSerializeErrorScript()

Indicates whether the ErrorScript property should be serialized.

ShouldSerializeFontProcessingOptions()

Indicates whether the FontProcessingOptions property should be serialized.

ShouldSerializePageConfigureScript()

Indicates whether the PageConfigureScript property should be serialized.

ShouldSerializeScriptingOptions()

Indicates whether the ScriptingOptions property should be serialized.

ShouldSerializeStyle()

Indicates whether the Style property should be serialized.

ShouldSerializeTagCloseParen()

Indicates whether the TagCloseParen property should be serialized.

ShouldSerializeTagEscapeString()

Indicates whether the TagEscapeString property should be serialized.

ShouldSerializeTagOpenParen()

Indicates whether the TagOpenParen property should be serialized.

ShouldSerializeTags()

Indicates whether the Tags property should be serialized.

ShouldSerializeTagsInputDialogClassName()

Indicates whether the TagsInputDialogClassName property should be serialized.

StartDoc()

Starts a new document.

ToRU(RectangleD, UnitTypeEnum)

Converts a RectangleD structure expressed in specified UnitTypeEnum units to a RectangleD expressed in the current document's ResolvedUnit units, using CreationDpi as the source resolution if srcType is Pixel.

ToRU(RectangleD, UnitTypeEnum, float, float)

Converts a RectangleD structure expressed in specified UnitTypeEnum units to a RectangleD expressed in the current document's ResolvedUnit units.

ToRU(double, UnitTypeEnum)

Converts a double value expressed in specified UnitTypeEnum units to a double value expressed in the current document's ResolvedUnit units, using CreationDpi as the source resolution if srcType is Pixel.

ToRU(double, UnitTypeEnum, float)

Converts a double value expressed in specified UnitTypeEnum units to a double value expressed in the current document's ResolvedUnit units.

Events

Name Description
BeforePagesClear

Occurs when the Pages collection is about to be cleared.

BusyStateChanged

Occurs when the BusyState property value has changed.

DefaultUnitChanged

Occurs when the DefaultUnit property value has changed.

DocumentEnded

Occurs when the document generation completes.

DocumentStarting

Occurs when the document generation is starting.

FormsStyleChanged

Occurs when the FormsStyle property value changes.

GenerateDocument

Occurs when the document needs to be generated. Allows user to build the document content in an event handler.

InputValueChanged

Occurs when the value of a RenderInputBase object within the document has been changed.

LongOperation

Occurs periodically during document generation. Allows to provide progress indication and the ability to cancel generation to the user.

PageAdded

Occurs during document generation when a page has been generated and added to the Pages collection, and the next page is about to be generated.

PageChanged

Occurs when an already generated page of the document has been changed, for example when the PageCount variable on the page needs to be updated.

PageConfigure

Occurs 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.

PageDeleted

Occurs when the page has been removed from the document's Pages collection. This event cannot fire during document generation.

PageUpdated

Occurs 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.

PagesClear

Occurs when the Pages collection has been cleared.

ResolvedUnitChanged

Occurs when the ResolvedUnit property value has changed.