C1.C1Preview Namespace : C1PrintDocument Class |
The following tables list the members exposed by C1PrintDocument.
Name | Description | |
---|---|---|
C1PrintDocument Constructor | Initializes a new instance of the C1PrintDocument class. |
Name | Description | |
---|---|---|
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. | |
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. | |
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 MeasurementDeviceEnum.Printer, CreationPrinterName specifies the printer. | |
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 MeasurementDeviceEnum.Printer. Set this property to null to select the reference printer automatically. | |
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 UnitTypeEnum.Inch. | |
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). | |
DocumentEndedScript | Gets or sets the script that is executed when the current document has finished generating. | |
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. | |
DoEvents | Gets or sets a value indicating whether the current C1PrintDocument should handle Windows messages while generating.
The default value is false. | |
EmfType | Gets or sets the type of metafiles created by the current document. The default is System.Drawing.Imaging.EmfType.EmfPlusOnly. | |
ErrorScript | Gets or sets the script that is executed when an error occurs in a script attached to the current document. | |
FontProcessingOptions | Gets the FontProcessingOptions object which determines how font subtitution and embedding are handled when the document generates. | |
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). | |
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 FormsKeyActionEnterEnum.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 FormsKeyActionTabEnum.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 FormsStyleEnum.Acrobat. | |
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 System.Drawing.Graphics used to measure/calculate layouts of C1PrintDocument objects. If this property is set to MeasurementDeviceEnum.Printer, MeasurementPrinterName specifies the printer. | |
MeasurementDpi | Gets the resolution (DPI) of the MeasurementGraphics object. | |
MeasurementGraphics | Gets the System.Drawing.Graphics object used to measure/calculate layouts of C1PrintDocument objects. | |
MeasurementPrinterName | Gets or sets the name of the printer used to provide System.Drawing.Graphics used to measure/calculate layouts of C1PrintDocument objects. This property is only used if MeasurementDevice is set to MeasurementDeviceEnum.Printer. | |
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 DocumentPageLayouts.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. | |
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 Tag.ShowInDialog.
The default value is false. | |
Stacking | Gets or sets the top-level stacking rule for the document body.
The default value is StackingRulesEnum.BlockTopToBottom. | |
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 RenderText.Text or ParagraphText.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 RenderText.Text or ParagraphText.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. | |
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 C1.C1Preview.Forms.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. | |
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. |
Name | Description | |
---|---|---|
AddAnchor | Overloaded. Adds an anchor (C1Anchor or C1AnchorText) at the current position in the document. Can be used only if IsStartEndDocMode is true. | |
AdvanceBlockFlow | 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 | Overloaded. Converts an absolute Unit value to the specified measurement units (this overload cannot convert to pixels). | |
CreateObjRef | (Inherited from System.MarshalByRefObject) | |
Dispose() | (Inherited from System.ComponentModel.Component) | |
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. | |
Export | Overloaded. Exports the document to a disk file. | |
FindAnchor | Searches for an C1Anchor with the specified Name in the current document. | |
FindInputFragment | Searches for the first occurrence of a RenderInputFragment object in the current document. | |
FromC1Report | Creates a new instance of the C1PrintDocument class representing the specified C1.C1Report.C1Report. | |
FromFile | Overloaded. Creates a new instance of the C1PrintDocument class, and loads the document from the specified file. The persistence format (C1DocumentFormatEnum.C1d or C1DocumentFormatEnum.C1dx) is determinated by the file extension. If the format cannot be determined by the extension, the C1DocumentFormatEnum.C1d format is used. | |
FromRdl | Creates a new instance of the C1PrintDocument class, and imports a RDL report definition into created document. | |
FromRU | Overloaded. Converts a double value expressed in the current document's ResolvedUnit units to other UnitTypeEnum units. | |
FromStream | Overloaded. Creates a new instance of C1PrintDocument class, and loads the document from the specified stream. | |
Generate | Overloaded. Generates the current document, using the RefreshModeEnum.RefreshCalculatedValues refresh mode. | |
GetLengthAbsValue | Overloaded. Converts an absolute length represented by a LengthAbs object to a double value expressed in the current document's ResolvedUnit units. | |
GetLifetimeService | (Inherited from System.MarshalByRefObject) | |
GetXpsC1Doc | Gets the C1.C1Preview.Export.Xps.XpsC1Doc object representing the current document. That object can be used to access the underlying System.Windows.Xps.Packaging.XpsDocument, which in turn can provide the System.Windows.Documents.FixedDocumentSequence (via the call to GetFixedDocumentSequence()) that can be assigned to the Document property of a document viewer.
Please note that to avoid memory leaks, the XpsC1Doc object returned by this method should be disposed when you're finished using it and/or the XpsDocument it provides. | |
HasEditableTags | Checks whether the document contains any tags that can be entered or changed in the tags input dialog. | |
ImportC1Report | Imports a C1.C1Report.C1Report report definition into the current document. | |
ImportRdl | Imports a RDL report definition into the current document. | |
InitializeLifetimeService | (Inherited from System.MarshalByRefObject) | |
IsInlineStarted | Indicates whether an inline paragraph is currently being created on the document. | |
Load | Overloaded. Loads the current document from a stream. The stream should contain a document in C1DocumentFormatEnum.C1d format. | |
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 | Overloaded. 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. | |
PageAsMetafile | Returns a System.Drawing.Imaging.Metafile representing the specified page. | |
Overloaded. Prints the current document with default printer settings, not showing the print progress dialog. | ||
PrintDialog | Overloaded. 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 | 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 | Overloaded. Renders an arc into the block flow of the current document. | |
RenderBlockEllipse | Overloaded. 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 | Renders a horizontal line with the specified width, starting at the left of the page, into the block flow of the current document. | |
RenderBlockImage | Overloaded. Renders the Image. | |
RenderBlockPie | Overloaded. Renders a pie into the block flow of the current document. | |
RenderBlockRectangle | Overloaded. Renders a rectangle into the block flow of the current document. | |
RenderBlockRichText | Overloaded. Renders the RTF text. | |
RenderBlockText | Overloaded. Renders a block of text into the block flow of the current document, using the specified font. | |
RenderBlockVertLine | Renders a vertical line with the specified height, starting at the current position, into the block flow of the current document. | |
RenderDirect | Overloaded. 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 | Overloaded. Adds an arc to the Body of the current document at a specific position on the current page, and resolves it. | |
RenderDirectEllipse | Overloaded. Adds an ellipse to the Body of the current document at a specific position on the current page, and resolves it. | |
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. | |
RenderDirectGraphicsEnd | Renders the internally maintained RenderGraphics object created with a previous call to RenderDirectGraphicsBegin onto the current page of the document. | |
RenderDirectImage | Overloaded. Adds an System.Drawing.Image to the Body of the current document at a specific position on the current page, and resolves it. | |
RenderDirectLine | Overloaded. Adds a line to the Body of the current document at a specific position on the current page, and resolves it. | |
RenderDirectPie | Overloaded. Adds a pie to the Body of the current document at a specific position on the current page, and resolves it. | |
RenderDirectPolygon | Overloaded. Creates an open RenderPolygon from a collection of UnitPoint objects, and renders it on the current page, at position specified by the points' coordinates. | |
RenderDirectRectangle | Overloaded. Adds a rectangle to the Body of the current document at a specific position on the current page, and resolves it. | |
RenderDirectRichText | Overloaded. Adds an RTF-formatted string to the Body of the current document at a specific position on the current page, and resolves it. | |
RenderDirectText | Overloaded. Adds a text to the Body of the current document at a specific position on the current page, and resolves it. | |
RenderInline | Renders a ParagraphObject into the current inline paragraph. | |
RenderInlineBegin | 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 | Overloaded. Renders an System.Drawing.Image into the current inline paragraph. | |
RenderInlineText | Overloaded. Renders a string into the current inline paragraph, using the specified style. | |
Save | Overloaded. Saves the current document to a disk file. The persistense format (C1DocumentFormatEnum.C1d or C1DocumentFormatEnum.C1dx) is determined by the specified file extension. The save format defaults to C1DocumentFormatEnum.C1d if the format cannot be determined from the extension. | |
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 MeasurementDeviceEnum.Printer. Otherwise, MeasurementDevice is set to MeasurementDeviceEnum.Screen. The selected device's resolution is returned by MeasurementDpi. | |
StartDoc | Starts a new document. | |
ToRU | Overloaded. Converts a double value expressed in specified UnitTypeEnum units to a double value expressed in the current document's ResolvedUnit units. | |
ToString | (Inherited from System.ComponentModel.Component) |
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. | |
PagesClear | Occurs when the Pages collection has been cleared. | |
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. | |
ResolvedUnitChanged | Occurs when the ResolvedUnit property value has changed. |