| Name | Description | |
|---|---|---|
 | AsyncMethodsUseAwaitPattern | Gets or sets a value indicating whether calls to async methods of the current document source expect the async/await pattern to be used by the calling code. If this property is true, then the *Completed events (such as OpenCompleted, GenerateCompleted and others) do not fire. |
| BusyState | Gets the current busy state of the current C1DocumentSource. |
| Container | (Inherited from System.ComponentModel.Component) |
| Credential | Gets or sets the System.Net.NetworkCredential object specifying the credentials which will be used to access data for document generation. |
| DefaultPrintOptions | Gets the C1PrintOptions object defining default print options used by printing methods of C1DocumentSource. |
| Dirty | Gets a value indicating whether the current content is dirty and does not correspond to the current values of DocumentLocation, Paginated etc. |
| Document | Gets a C1Document object produced by the current document source. |
| DocumentName | Gets a name of the document. |
| Features | Gets the C1DocumentSourceFeatures object specifying the set of features supported by this C1DocumentSource. |
| IsBusy | Gets the value indicating whether the current C1DocumentSource busy. |
| IsDisposed | Gets a value indicating whether this C1DocumentSource is disposed and can not be longer used. |
 | IsUserInteractive | Gets a value indicating whether the current document source is running in a user-interactive environment. This property returns false when running in a service, web app and so on. |
| Log | Gets the LogEntryList containing the list of events which occured during the last operation (generating, exporting etc). |
| PageCount | Gets the number of already generated pages. |
| PageSettings | Gets or sets the C1PageSettings object specifying the page settings to use when generating a paginated document (see Paginated). |
| Parameters | Gets a collection of parameters used to generate content. |
| Site | (Inherited from System.ComponentModel.Component) |
| SupportedExportProviders | Gets an array of exporters supported by the current document source object. |
The following tables list the members exposed by C1DocumentSource.
Public Properties
Public Methods
| Name | Description | |
|---|---|---|
 | AddToLog | Overloaded. Adds log entry to the Log list. |
| CancelAsync | Cancels currently executed async action and waits until action will be actually cancelled. |
| ClearContent | Clear generated content and sets Dirty to true. |
| CreateObjRef | (Inherited from System.MarshalByRefObject) |
| Dispose | (Inherited from System.ComponentModel.Component) |
| ExecuteAction | Executes an action specified by the C1DocumentAction object. |
| ExecuteActionAsync | Non-blocking (asynchronous) version of the ExecuteAction method. |
| ExecuteActionAsyncEx | |
| Export | Exports the document into a stream in an external format using the specified export filter. |
| ExportAsync | Non-blocking (asynchronous) version of the Export method. |
| ExportAsyncEx | |
| Generate | Generates the document. |
| GenerateAsync | Non-blocking (asynchronous) version of the Generate method. |
| GenerateAsyncEx | |
| GetDocumentRange | Creates the C1DocumentRange object on the base of two text positions specified by C1DocumentTextPosition objects. |
| GetLifetimeService | (Inherited from System.MarshalByRefObject) |
| GetPageDocumentRange | Creates a C1DocumentRange object that includes the specified page. This method can return null if the page contains no text. |
| GetWholeDocumentRange | Creates a C1DocumentRange object that includes the whole document. This method can return null if the document contains no text. |
| GetWordDocumentRange | Creates a C1DocumentRange object that defines a word containing a specified position in the document. |
| InitializeLifetimeService | (Inherited from System.MarshalByRefObject) |
| IsGenerateAllowed | Returns a value indicating whether the Generate method can be called at the moment. |
| Overloaded. Prints the generated document. | |
| ToString | (Inherited from System.ComponentModel.Component) |
| ValidateParameters | Validates the current parameter values, refreshes their valid values' lists if the values are valid. |
| ValidateParametersAsync | Non-blocking (asynchronous) version of the ValidateParameters method. |
| ValidateParametersAsyncEx |
Public Events
| Name | Description | |
|---|---|---|
 | BusyStateChanged | Occurs when the BusyState property value changes. |
| DirtyChanged | Occurs when the Dirty property value changes. |
| Disposed | (Inherited from System.ComponentModel.Component) |
| ExportCompleted | Occurs when the ExportAsync method has completed. |
| GenerateCompleted | Occurs when the GenerateAsync method has completed. |
| LongOperation | Occurs periodically during various document operations. Allows to provide progress indication and the ability to cancel some long operations such as document generation. |
| PageCountChanged | Occurs when the PageCount property value changes. |
| SecurityError | Occurs when a securiy exception occurs during a document source operation. This event allows to correct security-related properties like System.Net.NetworkCredential and retry a failed operation with new credentials. |
| ValidateParametersCompleted | Occurs when the ValidateParametersAsync method has completed. |
See Also