| Name | Description | |
|---|---|---|
 | C1PdfDocumentSource Constructor | Initializes a new instance of the C1PdfDocumentSource class. |
The following tables list the members exposed by C1PdfDocumentSource.
Public Constructors
Public Properties
| 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 GenerateCompleted, GenerateCompleted and others) do not fire. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| BusyState | Gets the current busy state of the current C1DocumentSource. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Credential | Overridden. Overridden. Gets or sets System.Net.NetworkCredential object defining credentials used in the PDF Document. |
| DefaultPrintOptions | Gets the C1PrintOptions object defining default print options used by printing methods of C1DocumentSource. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Dirty | Gets a value indicating whether the current content is dirty and does not correspond to the current values of Paginated etc. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Document | Overridden. Gets a C1Document object produced by the current document source. |
| DocumentName | Overridden. Gets a name of the document. |
| Features | Overridden. Gets the C1DocumentSourceFeatures object specifying the set of features supported by this C1DocumentSource. |
| IsBusy | Gets the value indicating whether the current C1DocumentSource busy. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| IsDisposed | Gets a value indicating whether this C1DocumentSource is disposed and can not be longer used. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Log | Gets the LogEntryList containing the list of events which occured during the last operation (generating, exporting etc). (Inherited from C1.Xaml.Document.C1DocumentSource) |
| PageCount | Gets the number of already generated pages. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Paginated | Gets or sets a value indicating whether the content should be represented as set of fixed sized pages. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Parameters | Gets a collection of parameters used to generate content. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| StorageFile | Gets or sets an Windows.Storage.IStorageFile containing the PDF content. Assigning a new value to this property will reset Stream to null. |
| Stream | Gets or sets an Windows.Storage.Streams.IRandomAccessStream containing PDF content. Assigning a new value to this property will reset StorageFile to null. |
| SupportedExportProviders | Overridden. Overridden. Gets an array of exporters supported by the current document source object. |
| UseSystemRendering | Gets or sets a value indicating whether to use the system PDF API to render documents.
The default is true. |
Public Methods
| Name | Description | |
|---|---|---|
 | AddToLog | Overloaded. Adds log entry to the Log list. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| CancelAsync | Cancels currently executed async action and waits until action will be actually cancelled. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ClearContent | Clear generated content and sets Dirty to true. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Dispose | Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ExecuteAction | Executes an action specified by the C1DocumentAction object. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ExecuteActionAsync | Non-blocking (asynchronous) version of the ExecuteAction method. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ExecuteActionAsyncEx | (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Export | Exports the document into a stream in an external format using the specified export filter. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ExportAsync | Non-blocking (asynchronous) version of the Export method. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ExportAsyncEx | (Inherited from C1.Xaml.Document.C1DocumentSource) |
| Generate | Generates the document. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| GenerateAsync | Non-blocking (asynchronous) version of the Generate method. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| GenerateAsyncEx | (Inherited from C1.Xaml.Document.C1DocumentSource) |
| GetContext | Overridden. For internal use. Returns a C1DocumentSourceContext object representing the current context of the C1DocumentSource. |
| GetDocumentRange | Overridden. Creates the C1DocumentRange object on the base of two text positions specified by C1DocumentTextPosition objects. |
| GetPageDocumentRange | Overridden. Creates a C1DocumentRange object that includes the specified page. This method can return null if the page contains no text. |
| GetWholeDocumentRange | Overridden. 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. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| IsGenerateAllowed | Returns a value indicating whether the Generate method can be called at the moment. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| LoadFromFileAsync | Loads the PDF document from the specified file. |
| LoadFromStreamAsync | Loads the PDF document from the specified stream. |
| SetContext | Overridden. For internal use. Sets the context for the current C1DocumentSource. |
| ShowPrintUIAsync | Overloaded. Initiates the user interface for printing a document. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ValidateParameters | Validates the current parameter values, refreshes their valid values' lists if the values are valid. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ValidateParametersAsync | Non-blocking (asynchronous) version of the ValidateParameters method. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ValidateParametersAsyncEx | (Inherited from C1.Xaml.Document.C1DocumentSource) |
Public Events
| Name | Description | |
|---|---|---|
 | BusyStateChanged | Occurs when the BusyState property value changes. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| DirtyChanged | Occurs when the Dirty property value changes. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ExportCompleted | Occurs when the ExportAsync method has completed. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| GenerateCompleted | Occurs when the GenerateAsync method has completed. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| LongOperation | Occurs periodically during various document operations. Allows to provide progress indication and the ability to cancel some long operations such as document generation. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| PageCountChanged | Occurs when the PageCount property value changes. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| PrintTaskCompleted | Occurs when the print task started with ShowPrintUIAsync method is finished. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| 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. (Inherited from C1.Xaml.Document.C1DocumentSource) |
| ValidateParametersCompleted | Occurs when the ValidateParametersAsync method has completed. (Inherited from C1.Xaml.Document.C1DocumentSource) |
See Also