Document Library for WinForms | ComponentOne
C1.Win.Document.8 Assembly / C1.Win.Document Namespace / C1PdfDocumentSource Class
Properties Methods Events


In This Topic
    C1PdfDocumentSource Class Members
    In This Topic

    The following tables list the members exposed by C1PdfDocumentSource.

    Public Constructors
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyGets 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.Win.Document.C1DocumentSource)
    Public PropertyGets the current busy state of the current C1DocumentSource. (Inherited from C1.Win.Document.C1DocumentSource)
    Public Property (Inherited from System.ComponentModel.Component)
    Public PropertyOverridden. Overridden. Gets or sets System.Net.NetworkCredential object defining credentials used in the PDF Document.  
    Public PropertyGets the C1PrintOptions object defining default print options used by printing methods of C1DocumentSource. (Inherited from C1.Win.Document.C1DocumentSource)
    Public PropertyGets a value indicating whether the current content is dirty and does not correspond to the current values of Paginated etc. (Inherited from C1.Win.Document.C1DocumentSource)
    Public PropertyOverridden. Gets a C1Document object produced by the current document source.  
    Public PropertyGets or sets the location of the PDF document. Assigning a new value to this property will reset Stream to null.  
    Public PropertyOverridden. Gets a name of the document.  
    Public PropertyOverridden. Gets the C1DocumentSourceFeatures object specifying the set of features supported by this C1DocumentSource.  
    Public PropertyGets the value indicating whether the current C1DocumentSource busy. (Inherited from C1.Win.Document.C1DocumentSource)
    Public PropertyGets a value indicating whether this C1DocumentSource is disposed and can not be longer used. (Inherited from C1.Win.Document.C1DocumentSource)
    Public PropertyGets the LogEntryList containing the list of events which occured during the last operation (generating, exporting etc). (Inherited from C1.Win.Document.C1DocumentSource)
    Public PropertyGets the number of already generated pages. (Inherited from C1.Win.Document.C1DocumentSource)
    Public PropertyGets a collection of parameters used to generate content. (Inherited from C1.Win.Document.C1DocumentSource)
    Public Property (Inherited from System.ComponentModel.Component)
    Public PropertyGets or sets the Stream object containing PDF content. Assigning this property new value will reset DocumentLocation to null.  
    Public PropertyOverridden. Overridden. Gets an array of exporters supported by the current document source object.  
    Top
    Protected Properties
    Public Methods
     NameDescription
    Public MethodOverloaded. Adds log entry to the Log list. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodCancels currently executed async action and waits until action will be actually cancelled. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodClear generated content and sets Dirty to true. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodOverloaded. Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodExecutes an action specified by the C1DocumentAction object. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodNon-blocking (asynchronous) version of the ExecuteAction method. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodNon-blocking (asynchronous) version of the ExecuteAction method. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodExports the document into a stream in an external format using the specified export filter. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodNon-blocking (asynchronous) version of the Export method. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodNon-blocking (asynchronous) version of the Export method. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodGenerates the document. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodNon-blocking (asynchronous) version of the Generate method. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodNon-blocking (asynchronous) version of the Generate method. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodOverridden. Creates the C1DocumentRange object on the base of two text positions specified by C1DocumentTextPosition objects.  
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodOverridden. Creates a C1DocumentRange object that includes the specified page. This method can return null if the page contains no text.  
    Public MethodOverridden. Creates a C1DocumentRange object that includes the whole document. This method can return null if the document contains no text.  
    Public MethodCreates a C1DocumentRange object that defines a word containing a specified position in the document. (Inherited from C1.Win.Document.C1DocumentSource)
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodReturns a value indicating whether the Generate method can be called at the moment. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodLoads document from file.  
    Public MethodLoads document from Stream.  
    Public MethodOverloaded. Prints the generated document. (Inherited from C1.Win.Document.C1DocumentSource)
    Public Method (Inherited from System.ComponentModel.Component)
    Public MethodValidates the current parameter values, refreshes their valid values' lists if the values are valid. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodNon-blocking (asynchronous) version of the ValidateParameters method. (Inherited from C1.Win.Document.C1DocumentSource)
    Public MethodNon-blocking (asynchronous) version of the ValidateParameters method. (Inherited from C1.Win.Document.C1DocumentSource)
    Top
    Protected Methods
     NameDescription
    Protected MethodCreates the ParameterCollection object. (Inherited from C1.Win.Document.C1DocumentSource)
    Protected Method (Inherited from System.ComponentModel.Component)
    Protected MethodFor internal use. (Inherited from C1.Win.Document.C1DocumentSource)
    Protected Method (Inherited from System.ComponentModel.Component)
    Protected MethodOverridden. For internal use. It is called from the constructor.  
    Protected MethodOverloaded.  (Inherited from System.MarshalByRefObject)
    Protected MethodFor internal use. (Inherited from C1.Win.Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.Document.C1DocumentSource)
    Protected MethodFor internal use. (Inherited from C1.Win.Document.C1DocumentSource)
    Protected MethodResets value of the DocumentLocation property to default value.  
    Protected MethodIndicates whether the DocumentLocation property should be persisted.  
    Top
    Public Events
     NameDescription
    Public EventOccurs when the BusyState property value changes. (Inherited from C1.Win.Document.C1DocumentSource)
    Public EventOccurs when the Dirty property value changes. (Inherited from C1.Win.Document.C1DocumentSource)
    Public Event (Inherited from System.ComponentModel.Component)
    Public EventOccurs when the ExportAsync method has completed. (Inherited from C1.Win.Document.C1DocumentSource)
    Public EventOccurs when the GenerateAsync method has completed. (Inherited from C1.Win.Document.C1DocumentSource)
    Public EventOccurs 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.Win.Document.C1DocumentSource)
    Public EventOccurs when the PageCount property value changes. (Inherited from C1.Win.Document.C1DocumentSource)
    Public EventOccurs 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.Win.Document.C1DocumentSource)
    Public EventOccurs when the ValidateParametersAsync method has completed. (Inherited from C1.Win.Document.C1DocumentSource)
    Top
    See Also