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


In This Topic
    C1DocumentSource Class Members
    In This Topic

    The following tables list the members exposed by C1DocumentSource.

    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.  
    Public PropertyGets the current busy state of the current C1DocumentSource.  
    Public Property (Inherited from System.ComponentModel.Component)
    Public PropertyGets or sets the System.Net.NetworkCredential object specifying the credentials which will be used to access data for document generation.  
    Public PropertyGets the C1PrintOptions object defining default print options used by printing methods of C1DocumentSource.  
    Public PropertyGets a value indicating whether the current content is dirty and does not correspond to the current values of Paginated etc.  
    Public PropertyGets a C1Document object produced by the current document source.  
    Public PropertyGets a name of the document.  
    Public PropertyGets the C1DocumentSourceFeatures object specifying the set of features supported by this C1DocumentSource.  
    Public PropertyGets the value indicating whether the current C1DocumentSource busy.  
    Public PropertyGets a value indicating whether this C1DocumentSource is disposed and can not be longer used.  
    Public Propertystatic (Shared in Visual Basic)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.  
    Public PropertyGets the LogEntryList containing the list of events which occured during the last operation (generating, exporting etc).  
    Public PropertyGets the number of already generated pages.  
    Public PropertyGets or sets the C1PageSettings object specifying the page settings to use when generating a paginated document (see Paginated).  
    Public PropertyGets a collection of parameters used to generate content.  
    Public Property (Inherited from System.ComponentModel.Component)
    Public PropertyGets 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.  
    Public MethodCancels currently executed async action and waits until action will be actually cancelled.  
    Public MethodClear generated content and sets Dirty to true.  
    Public MethodOverloaded. Overridden. Releases the unmanaged resources used by the Component and optionally releases the managed resources.  
    Public MethodExecutes an action specified by the C1DocumentAction object.  
    Public MethodNon-blocking (asynchronous) version of the ExecuteAction method.  
    Public MethodNon-blocking (asynchronous) version of the ExecuteAction method.  
    Public MethodExports the document into a stream in an external format using the specified export filter.  
    Public MethodNon-blocking (asynchronous) version of the Export method.  
    Public MethodNon-blocking (asynchronous) version of the Export method.  
    Public MethodGenerates the document.  
    Public MethodNon-blocking (asynchronous) version of the Generate method.  
    Public MethodNon-blocking (asynchronous) version of the Generate method.  
    Public MethodCreates the C1DocumentRange object on the base of two text positions specified by C1DocumentTextPosition objects.  
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodCreates a C1DocumentRange object that includes the specified page. This method can return null if the page contains no text.  
    Public MethodCreates 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.  
    Public Method (Inherited from System.MarshalByRefObject)
    Public MethodReturns a value indicating whether the Generate method can be called at the moment.  
    Public MethodOverloaded. Prints the generated document.  
    Public Method (Inherited from System.ComponentModel.Component)
    Public MethodValidates the current parameter values, refreshes their valid values' lists if the values are valid.  
    Public MethodNon-blocking (asynchronous) version of the ValidateParameters method.  
    Public MethodNon-blocking (asynchronous) version of the ValidateParameters method.  
    Top
    Protected Methods
     NameDescription
    Protected MethodCreates the ParameterCollection object.  
    Protected Method (Inherited from System.ComponentModel.Component)
    Protected MethodFor internal use.  
    Protected Method (Inherited from System.ComponentModel.Component)
    Protected MethodCalled from constructor, initializes an object.  
    Protected MethodOverloaded.  (Inherited from System.MarshalByRefObject)
    Protected MethodFor internal use.  
    Protected MethodFor internal use.  
    Protected MethodFor internal use.  
    Protected MethodFor internal use.  
    Protected MethodFor internal use.  
    Protected MethodFor internal use.  
    Protected MethodFor internal use.  
    Protected MethodFor internal use.  
    Protected MethodFor internal use.  
    Protected MethodFor internal use.  
    Protected MethodFor internal use.  
    Top
    Public Events
     NameDescription
    Public EventOccurs when the BusyState property value changes.  
    Public EventOccurs when the Dirty property value changes.  
    Public Event (Inherited from System.ComponentModel.Component)
    Public EventOccurs when the ExportAsync method has completed.  
    Public EventOccurs when the GenerateAsync method has completed.  
    Public EventOccurs periodically during various document operations. Allows to provide progress indication and the ability to cancel some long operations such as document generation.  
    Public EventOccurs when the PageCount property value changes.  
    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.  
    Public EventOccurs when the ValidateParametersAsync method has completed.  
    Top
    See Also