The C1PrintDocument type exposes the following members.

Methods

  Name Description
Public method 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.

Public method 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.

Public method 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.
Public method AdvanceBlockFlow
Advances the current block flow position by the specified distance.
Public method CanRenderBlock
Indicates whether rendering in the block flow is permitted now.
Public method CanRenderDirect
Indicates whether direct rendering is permitted now.
Public method Clear
Clears the current document, sets all properties to their default values.
Public method ClearGeneratedPages
Clears the pages and other info created during document generation. This method does not clear the document structure/content though.
Public method ConvertUnit(Unit, UnitTypeEnum)
Converts an absolute Unit value to the specified measurement units (this overload cannot convert to pixels).
Public method ConvertUnit(Unit, UnitTypeEnum, Single)
Converts an absolute Unit value to the specified measurement units.
Public method EditTags
Shows the tags input dialog, allows the user to enter/update the values of Tag objects contained in the Tags collection.
Public method EndDoc
Finishes generation of a document.
Public method Export(String)
Exports the document to a disk file.
Public method Export(Stream, ExportProvider)
Exports the document to a stream.
Public method Export(String, Boolean)
Exports the document to a disk file.
Public method Export(Stream, ExportProvider, Boolean)
Exports the document to a stream.
Public method Export(String, OutputRange, Boolean)
Exports the document to a disk file.
Public method Export(Stream, ExportProvider, OutputRange, Boolean)
Exports the document to a stream.
Public method Export(String, ExportProvider, OutputRange, Boolean)
Exports the document to a disk file.
Public method FindAnchor
Searches for an C1Anchor with the specified Name in the current document.
Public method FindInputFragment
Searches for the first occurrence of a RenderInputFragment object in the current document.
Public method Static member FromC1Report
Creates a new instance of the C1PrintDocument class representing the specified C1Report.
Public method Static member FromRdl Obsolete.
Creates a new instance of the C1PrintDocument class, and imports a RDL report definition into created document.
Public method 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.
Public method 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.
Public method 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.
Public method FromRU(Double, UnitTypeEnum, Single)
Converts a double value expressed in the current document's ResolvedUnit units to other UnitTypeEnum units.
Public method FromRU(Double, Single, Boolean)
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).

Public method FromRU(Region, UnitTypeEnum, Single, Single)
Transforms (scales) a Region object expressed in the current document's ResolvedUnit units so that it uses other UnitTypeEnum units.
Public method FromRU(OffsetsD, UnitTypeEnum, Single, Single)
Converts a OffsetsD value expressed in the current document's ResolvedUnit units to other UnitTypeEnum units.
Public method FromRU(OffsetsD, Single, Single, Boolean)
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).

Public method FromRU(PointD, UnitTypeEnum, Single, Single)
Converts a PointD value expressed in the current document's ResolvedUnit units to other UnitTypeEnum units.
Public method FromRU(RectangleD, UnitTypeEnum, Single, Single)
Converts a RectangleD value expressed in the current document's ResolvedUnit units to other UnitTypeEnum units.
Public method FromRU(RectangleD, Single, Single, Boolean)
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).

Public method Generate()()()()
Generates the current document, using the RefreshCalculatedValues refresh mode.
Public method Generate(RefreshModeEnum)
Generates the current document. Depending on the specified refresh mode, may update data-bound and calculated values.
Public method GetLengthAbsValue(LengthAbs, Font)
Converts an absolute length represented by a LengthAbs object to a double value expressed in the current document's ResolvedUnit units.
Public method GetLengthAbsValue(LengthAbs, Style, IScriptContext)
Converts an absolute length represented by a LengthAbs object to a double value expressed in the current document's ResolvedUnit units.
Public method HasEditableTags
Checks whether the document contains any tags that can be entered or changed in the tags input dialog.
Public method ImportC1Report
Imports a C1Report report definition into the current document.
Public method ImportRdl Obsolete.
Imports a RDL report definition into the current document.
Public method IsInlineStarted
Indicates whether an inline paragraph is currently being created on the document.
Public method Load(Stream)
Loads the current document from a stream. The stream should contain a document in C1d format.
Public method 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.
Public method Load(Stream, C1DocumentFormatEnum)
Loads the current document from a stream.
Public method Load(String, C1DocumentFormatEnum)
Loads the current document from a file.
Public method 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.
Public method 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.
Public method NewPage()()()()
Creates a new page and adds it to the document.
Public method NewPage(PageLayout)
Creates a new page and adds it to the document.
Public method 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.
Public method PageAsMetafile
Returns a Metafile representing the specified page.
Public method Print()()()()
Prints the current document with default printer settings, not showing the print progress dialog.
Public method Print(PrinterSettings)
Prints the current document with specified printer settings, not showing the print progress dialog.
Public method Print(PrinterSettings, OutputRange)
Prints a range of pages of the current document with specified printer settings, not showing the print progress dialog.
Public method Print(PrinterSettings, Boolean)
Prints the document with specified printer settings, optionally showing the print progress dialog.
Public method Print(PrinterSettings, OutputRange, Boolean)
Prints a range of pages of the current document with specified printer settings, optionally showing the print progress dialog.
Public method 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.
Public method Print(PrinterSettings, PageSettings, Boolean)
Prints the current document with specified printer and default page settings, optionally showing the print progress dialog.
Public method Print(PrinterSettings, PageSettings, OutputRange, Boolean)
Prints a range of pages of the current document with specified printer and default page settings, optionally showing the print progress dialog.
Public method PrintDialog()()()()
Shows the standard print dialog, allowing the user to print the current document.
Public method PrintDialog(PrinterSettings, array<Int32>[]()[][], Boolean)
Shows the standard print dialog, allowing the user to print the current document.
Public method 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.
Public method RenderBlock
Adds a RenderObject into the block flow of the current document, and resolves it.

This method can only be used if IsStartEndDocMode is true.

Public method RenderBlockArc(Unit, Unit, Single, Single, LineDef)
Renders an arc into the block flow of the current document.
Public method RenderBlockArc(Unit, Unit, Single, Single, Style)
Renders an arc into the block flow of the current document.
Public method RenderBlockArc(Unit, Unit, Single, Single, LineDef, Brush)
Renders an arc into the block flow of the current document.
Public method RenderBlockArc(Unit, Unit, Single, Single, LineDef, Color)
Renders an arc into the block flow of the current document.
Public method RenderBlockArc(Unit, Unit, Single, Single, Color, Unit)
Renders an arc into the block flow of the current document.
Public method RenderBlockArc(Unit, Unit, Single, Single, Color, Unit, Color)
Renders an arc into the block flow of the current document.
Public method RenderBlockEllipse(Unit, Unit, LineDef)
Renders an ellipse into the block flow of the current document.
Public method RenderBlockEllipse(Unit, Unit, Style)
Renders an ellipse into the block flow of the current document.
Public method RenderBlockEllipse(Unit, Unit, LineDef, Brush)
Renders an ellipse into the block flow of the current document.
Public method RenderBlockEllipse(Unit, Unit, LineDef, Color)
Renders an ellipse into the block flow of the current document.
Public method RenderBlockEllipse(Unit, Unit, Color, Unit)
Renders an ellipse into the block flow of the current document.
Public method RenderBlockEllipse(Unit, Unit, Color, Unit, Color)
Renders an ellipse into the block flow of the current document.
Public method RenderBlockGraphicsBegin
Creates an internally maintained RenderGraphics object that can be used to add graphics to the block flow of the current document.
Public method RenderBlockGraphicsEnd
Adds the internally maintained RenderGraphics object created with a previous call to RenderBlockGraphicsBegin()()()() to the block flow of the current document.
Public method RenderBlockHorzLine
Renders a horizontal line with the specified width, starting at the left of the page, into the block flow of the current document.
Public method RenderBlockImage(Image)
Renders the Image.
Public method RenderBlockImage(Image, Object, Object, ImageAlign)
Renders the Image.
Public method RenderBlockImage(Image, Object, Object, Style)
Renders the Image.
Public method RenderBlockPie(Unit, Unit, Single, Single, LineDef)
Renders a pie into the block flow of the current document.
Public method RenderBlockPie(Unit, Unit, Single, Single, Style)
Renders a pie into the block flow of the current document.
Public method RenderBlockPie(Unit, Unit, Single, Single, LineDef, Brush)
Renders a pie into the block flow of the current document.
Public method RenderBlockPie(Unit, Unit, Single, Single, LineDef, Color)
Renders a pie into the block flow of the current document.
Public method RenderBlockPie(Unit, Unit, Single, Single, Color, Unit)
Renders a pie into the block flow of the current document.
Public method RenderBlockPie(Unit, Unit, Single, Single, Color, Unit, Color)
Renders a pie into the block flow of the current document.
Public method RenderBlockRectangle(Unit, Unit, LineDef)
Renders a rectangle into the block flow of the current document.
Public method RenderBlockRectangle(Unit, Unit, Style)
Renders a rectangle into the block flow of the current document.
Public method RenderBlockRectangle(Unit, Unit, LineDef, Brush)
Renders a rectangle into the block flow of the current document.
Public method RenderBlockRectangle(Unit, Unit, LineDef, Color)
Renders a rectangle into the block flow of the current document.
Public method RenderBlockRectangle(Unit, Unit, Color, Unit)
Renders a rectangle into the block flow of the current document.
Public method RenderBlockRectangle(Unit, Unit, Color, Unit, Color)
Renders a rectangle into the block flow of the current document.
Public method RenderBlockRichText(String)
Renders the RTF text with parent width and autoheight.
Public method RenderBlockRichText(String, Object)
Renders the RTF text with autoheight.
Public method RenderBlockRichText(String, Object, Object, Style)
Renders the RTF text.
Public method RenderBlockText(String)
Renders a block of text into the block flow of the current document.
Public method RenderBlockText(String, AlignHorzEnum)
Renders a block of text into the block flow of the current document, using the specified horizontal alignment.
Public method RenderBlockText(String, Style)
Renders a block of text into the block flow of the current document, using the specified Style.
Public method RenderBlockText(String, Color)
Renders a block of text into the block flow of the current document, using the specified text color.
Public method RenderBlockText(String, Font)
Renders a block of text into the block flow of the current document, using the specified font.
Public method RenderBlockText(String, Font, AlignHorzEnum)
Renders a block of text into the block flow of the current document, using the specified font and horizontal alignment.
Public method RenderBlockText(String, Font, Color)
Renders a block of text into the block flow of the current document, using the specified font and text color.
Public method 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.
Public method 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.
Public method RenderBlockVertLine
Renders a vertical line with the specified height, starting at the current position, into the block flow of the current document.
Public method 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.

Public method 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.

Public method RenderDirectArc(Unit, Unit, Unit, Unit, Single, Single, LineDef)
Adds an arc to the Body of the current document at a specific position on the current page, and resolves it.
Public method RenderDirectArc(Unit, Unit, Unit, Unit, Single, Single, Style)
Adds an arc to the Body of the current document at a specific position on the current page, and resolves it.
Public method RenderDirectArc(Unit, Unit, Unit, Unit, Single, Single, LineDef, Brush)
Adds an arc to the Body of the current document at a specific position on the current page, and resolves it.
Public method RenderDirectArc(Unit, Unit, Unit, Unit, Single, Single, LineDef, Color)
Adds an arc to the Body of the current document at a specific position on the current page, and resolves it.
Public method RenderDirectArc(Unit, Unit, Unit, Unit, Single, Single, Color, Unit)
Adds an arc to the Body of the current document at a specific position on the current page, and resolves it.
Public method RenderDirectArc(Unit, Unit, Unit, Unit, Single, Single, Color, Unit, Color)
Adds an arc to the Body of the current document at a specific position on the current page, and resolves it.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method RenderDirectGraphicsBegin
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.
Public method RenderDirectGraphicsEnd
Renders the internally maintained RenderGraphics object created with a previous call to RenderDirectGraphicsBegin(Unit, Unit) onto the current page of the document.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method RenderDirectPie(Unit, Unit, Unit, Unit, Single, Single, LineDef)
Adds a pie to the Body of the current document at a specific position on the current page, and resolves it.
Public method RenderDirectPie(Unit, Unit, Unit, Unit, Single, Single, Style)
Adds a pie to the Body of the current document at a specific position on the current page, and resolves it.
Public method RenderDirectPie(Unit, Unit, Unit, Unit, Single, Single, LineDef, Brush)
Adds a pie to the Body of the current document at a specific position on the current page, and resolves it.
Public method RenderDirectPie(Unit, Unit, Unit, Unit, Single, Single, LineDef, Color)
Adds a pie to the Body of the current document at a specific position on the current page, and resolves it.
Public method RenderDirectPie(Unit, Unit, Unit, Unit, Single, Single, Color, Unit)
Adds a pie to the Body of the current document at a specific position on the current page, and resolves it.
Public method RenderDirectPie(Unit, Unit, Unit, Unit, Single, Single, Color, Unit, Color)
Adds a pie to the Body of the current document at a specific position on the current page, and resolves it.
Public method 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.
Public method 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.

Public method 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.

Public method RenderDirectPolygon(IEnumerable, Boolean, Style)
Creates a RenderPolygon from a collection of UnitPoint objects, and renders it on the current page, at position specified by the points' coordinates.
Public method 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.
Public method 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.

Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method 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.
Public method RenderInline
Renders a ParagraphObject into the current inline paragraph.
Public method RenderInlineBegin
Begins rendering of a new inline paragraph into the Body of the current document, using the specified Style and dimensions.
Public method RenderInlineEnd
Ends rendering of the current inline paragraph.
Public method RenderInlineImage(Image)
Renders an Image into the current inline paragraph.
Public method RenderInlineImage(Image, Style)
Renders an Image into the current inline paragraph, using the specified Style.
Public method RenderInlineText(String)
Renders a string into the current inline paragraph.
Public method RenderInlineText(String, Style)
Renders a string into the current inline paragraph, using the specified style.
Public method RenderInlineText(String, Color)
Renders a string into the current inline paragraph, using the specified text color.
Public method RenderInlineText(String, Font)
Renders a string into the current inline paragraph, using the specified font.
Public method RenderInlineText(String, FontStyle)
Renders a string into the current inline paragraph, using the specified font style.
Public method RenderInlineText(String, Font, Color)
Renders a string into the current inline paragraph, using the specified font and text color.
Public method Save(Stream)
Saves the current document to a stream using the C1d format.
Public method 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.
Public method Save(Stream, C1DocumentFormatEnum)
Saves the current document to a stream using the specified format.
Public method Save(String, C1DocumentFormatEnum)
Saves the current document to a disk file using the specified format.
Public method Static member 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.
Public method StartDoc
Starts a new document.
Public method 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.
Public method 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.
Public method ToRU(Double, UnitTypeEnum, Single)
Converts a double value expressed in specified UnitTypeEnum units to a double value expressed in the current document's ResolvedUnit units.
Public method ToRU(RectangleD, UnitTypeEnum, Single, Single)
Converts a RectangleD structure expressed in specified UnitTypeEnum units to a RectangleD expressed in the current document's ResolvedUnit units.

Properties

  Name Description
Public property AcceptButton
Gets the RenderInputButton object representing the accept button in the current document (the first RenderInputButton object with AcceptButton property set to true).
Public property 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.

Public property 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.

Public property Static member AssemblyVersion
Gets the version of C1PrintDocument assembly.
Public property AutoEmbedFonts Obsolete.

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.

Public property 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.
Public property 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.
Public property Body
Gets the DocumentBody object representing the body of the current document.
Public property Static member 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.
Public property BusyState
Gets the current busy state of the current document.
Public property 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.
Public property ClipPage
Gets or sets a value indicating whether to clip the content of the current document to page margins.

The default value is false.

Public property CompatibilityOptions
Gets the CompatibilityOptions object which determines compatibility with previous versions of C1PrintDocument.
Public property CreationDpi
Gets or sets the resolution (DPI) used during document creation. Note that if ResolvedUnit is Pixel, this is also the resolution of ResolvedUnit pixels.
Public property CreationGraphics
Gets or sets the Graphics object used when the document is created. That Graphics is used to calculate text sizes, measure RTF text, and so on.
Public property CreationMode
Gets the document creation mode.
Public property CurrentBlockGraphics
Gets the current Graphics object created by the last call to RenderBlockGraphicsBegin()()()().
Public property CurrentBlockRenderGraphics
Gets the current RenderGraphics object created by the last call to RenderBlockGraphicsBegin()()()().
Public property CurrentDirectGraphics
Gets the current Graphics object created by the last call to RenderDirectGraphicsBegin(Unit, Unit).
Public property CurrentDirectRenderGraphics
Gets the current RenderGraphics object created by the last call to RenderDirectGraphicsBegin(Unit, Unit).
Public property CurrentPage
Gets the current generating page, returns null if document in not generating state.
Public property CurrentPageArea
Gets the current generating area of page, returns null if document in not generating state.
Public property 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.

Public property DataSchema
Gets the C1DataSchema object representing the data schema built into the current document.
Public property 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.

Public property 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).
Public property 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).

Public property DocumentDirectoryName
Gets the directory of the DocumentFileName.
Public property DocumentEndedScript
Gets or sets the script that is executed when the current document has finished generating.
Public property DocumentFileName
Gets the file name associated with the current document (i.e. the document was either loaded from that file, or saved to it).
Public property 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.

Public property Static member 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).
Public property DocumentInfo
Gets or sets the DocumentInfo object containing the information about the current document (such as author, company, and so on).
Public property DocumentStartingScript
Gets or sets the script that is executed when the current document starts generating.
Public property DoEvents
Gets or sets a value indicating whether the current C1PrintDocument should handle Windows messages while generating.

The default value is false.

Public property 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.

Public property EmfType
Gets or sets the type of metafiles created by the current document. The default is EmfPlusOnly.
Public property ErrorCode Obsolete.
Obsolete. Now gets the Code of the first element in the Warnings collection, or GenerateErrorEnum.None if there are no warnings.
Public property ErrorDesc Obsolete.
Obsolete. Now gets the description of the first element in the Warnings collection, or an empty string if there are no warnings.
Public property ErrorScript
Gets or sets the script that is executed when an error occurs in a script attached to the current document.
Public property ExportProviders
Gets the collection of all registered ExportProvider objects.
Public property FontHandling
Gets or sets a value indicating how font embedding and substitution are handled by the current C1PrintDocument.

For details on the available options see members of the FontHandling enumeration.

Note that if this property is set to a value other than EmbedFonts or EmbedActualFonts (i.e. fonts are not embedded automatically), you may manually add certain fonts that you want embedded, to the document's EmbeddedFonts collection.

The default value of this property is None.

Public property Static member FormatVersion
Gets a 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).
Public property 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.

Public property 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.

Public property 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.

Public property 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.
Public property HasGenerateDocumentHandler
Gets the value indicating whether a handler is attached to the GenerateDocument event of the current document.
Public property IsGenerating
Indicates whether the document is currently being generated.
Public property 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.

Public property IsStartEndDocMode
Gets a value indicating whether the document is being generated via StartDoc()()()() / EndDoc()()()() methods.
Public property 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.

Public property Static member 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.
Public property Static member MeasurementDpi
Gets the resolution (DPI) of the MeasurementGraphics object.
Public property Static member MeasurementGraphics
Gets the Graphics object used to measure/calculate layouts of C1PrintDocument objects.
Public property Static member 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.
Public property Outlines
Gets the OutlineNodeCollection representing the collection of OutlineNode objects of the current document.
Public property 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.

Public property 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.)
Public property 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.
Public property PageNumberingChange
Gets or sets the PageNumberingChange object applied to the first page of the document.
Public property Pages
Gets the collection of document's pages.
Public property Reflowable
Gets a value indicating whether the document is reflowable.
Public property 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).

Public property ScriptingOptions
Gets the ScriptingOptions object defining the scripting options of this C1PrintDocument object.
Public property 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.

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

The default value is BlockTopToBottom.

Public property Style
Gets the main (root) Style of the current document.
Public property SystemTags
Gets the collection of system tags (objects derived from TagSys) associated with the current document.
Public property 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 "]".

Public property 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 "\".

Public property 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 "[".

Public property Tags
Gets the TagCollection representing the collection of user-defined Tag objects in the current document.
Public property 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.
Public property 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.
Public property 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.

Public property 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.
Public property 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.

Public property Static member 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.
Public property UserData
Gets or sets arbitrary data associated with the current document.
Public property Warnings
Gets the collection of warnings produced by the document's generation.

Events

  Name Description
Public event BeforePagesClear
Occurs before the Pages collection is cleared.
Public event BusyStateChanged
Occurs when the BusyState property value has changed.
Public event DefaultUnitChanged
Occurs when the DefaultUnit property value has changed.
Public event DocumentEnded
Occurs when the document generation completes.
Public event DocumentStarting
Occurs when the document generation is started.
Public event FormsStyleChanged
Occurs when the FormsStyle property value changes.
Public event GenerateDocument
Allows user to build document content in event handler.
Public event InputValueChanged
Occurs when the value of RenderInputBase object within document is changed.
Public event LongOperation
Occurs periodically during document generation. Allows to provide progress indication and the ability to cancel generation to the user.
Public event PageAdded
Occurs only during generating of the document, when generating of page of document is finished, page is added to the Pages collection and switch to other page is occured.
Public event PageChanged
Occurs only during generating of the document, when page of document which was added to document is changed, for example when page numbering is changed or PageCount property is updated for page.
Public event PageConfigure
Occurs when a new empty page is created and added to the document, the page is added to the Pages collection but *not resolved*, use this method only for changing layout of page.
Public event PageDeleted
Occurs when the page is removed from the document (from the Pages collection). This event cannot occur during document generation.
Public event PagesClear
Occurs when the Pages collection is cleared.
Public event PageUpdated
Occurs when page of document is changed. This event occurs very often while document is generating, it is called each time when a fragment of object is added to page or removed from page.
Public event ResolvedUnitChanged
Occurs when the ResolvedUnit property value has changed.

See Also