The C1PrintDocument type exposes the following members.
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).
|
|
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 | 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. |
|
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.
|
|
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.
|
|
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.
|
|
CreationMode |
Gets the document creation mode.
|
|
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). |
|
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.
|
|
DoEvents |
Gets or sets a value indicating whether the current C1PrintDocument
should handle Windows messages while generating.
The default value is false. |
|
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.
Obsolete. Now gets the Code of the first element in the Warnings collection,
or GenerateErrorEnum.None if there are no warnings.
|
|
ErrorDesc | Obsolete.
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 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. |
|
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 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.
|