C1.C1Preview Namespace : C1PrintDocument Class |
For a list of all members of this type, see C1PrintDocument members.
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. |