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 PropertyAsyncMethodsUseAwaitPatternGets 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 PropertyBusyStateGets the current busy state of the current C1DocumentSource.  
    Public PropertyContainer (Inherited from System.ComponentModel.Component)
    Public PropertyCredentialGets or sets the System.Net.NetworkCredential object specifying the credentials which will be used to access data for document generation.  
    Public PropertyDefaultPrintOptionsGets the C1PrintOptions object defining default print options used by printing methods of C1DocumentSource.  
    Public PropertyDirtyGets a value indicating whether the current content is dirty and does not correspond to the current values of Paginated etc.  
    Public PropertyDocumentGets a C1Document object produced by the current document source.  
    Public PropertyDocumentNameGets a name of the document.  
    Public PropertyFeaturesGets the C1DocumentSourceFeatures object specifying the set of features supported by this C1DocumentSource.  
    Public PropertyIsBusyGets the value indicating whether the current C1DocumentSource busy.  
    Public PropertyIsDisposedGets a value indicating whether this C1DocumentSource is disposed and can not be longer used.  
    Public Propertystatic (Shared in Visual Basic)IsUserInteractiveGets 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 PropertyLogGets the LogEntryList containing the list of events which occured during the last operation (generating, exporting etc).  
    Public PropertyPageCountGets the number of already generated pages.  
    Public PropertyPageSettingsGets or sets the C1PageSettings object specifying the page settings to use when generating a paginated document (see Paginated).  
    Public PropertyParametersGets a collection of parameters used to generate content.  
    Public PropertySite (Inherited from System.ComponentModel.Component)
    Public PropertySupportedExportProvidersGets an array of exporters supported by the current document source object.  
    Top
    Protected Properties
     NameDescription
    Protected PropertyCanRaiseEvents (Inherited from System.ComponentModel.Component)
    Protected PropertyDesignMode (Inherited from System.ComponentModel.Component)
    Protected PropertyEvents (Inherited from System.ComponentModel.Component)
    Top
    Public Methods
     NameDescription
    Public MethodAddToLogOverloaded. Adds log entry to the Log list.  
    Public MethodCancelAsyncCancels currently executed async action and waits until action will be actually cancelled.  
    Public MethodClearContentClear generated content and sets Dirty to true.  
    Public MethodDisposeOverloaded. Overridden. Releases the unmanaged resources used by the Component and optionally releases the managed resources.  
    Public MethodExecuteActionExecutes an action specified by the C1DocumentAction object.  
    Public MethodExecuteActionAsyncNon-blocking (asynchronous) version of the ExecuteAction method.  
    Public MethodExecuteActionAsyncExNon-blocking (asynchronous) version of the ExecuteAction method.  
    Public MethodExportExports the document into a stream in an external format using the specified export filter.  
    Public MethodExportAsyncNon-blocking (asynchronous) version of the Export method.  
    Public MethodExportAsyncExNon-blocking (asynchronous) version of the Export method.  
    Public MethodGenerateGenerates the document.  
    Public MethodGenerateAsyncNon-blocking (asynchronous) version of the Generate method.  
    Public MethodGenerateAsyncExNon-blocking (asynchronous) version of the Generate method.  
    Public MethodGetDocumentRangeCreates the C1DocumentRange object on the base of two text positions specified by C1DocumentTextPosition objects.  
    Public MethodGetLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodGetPageDocumentRangeCreates a C1DocumentRange object that includes the specified page. This method can return null if the page contains no text.  
    Public MethodGetWholeDocumentRangeCreates a C1DocumentRange object that includes the whole document. This method can return null if the document contains no text.  
    Public MethodGetWordDocumentRangeCreates a C1DocumentRange object that defines a word containing a specified position in the document.  
    Public MethodInitializeLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodIsGenerateAllowedReturns a value indicating whether the Generate method can be called at the moment.  
    Public MethodPrintOverloaded. Prints the generated document.  
    Public MethodToString (Inherited from System.ComponentModel.Component)
    Public MethodValidateParametersValidates the current parameter values, refreshes their valid values' lists if the values are valid.  
    Public MethodValidateParametersAsyncNon-blocking (asynchronous) version of the ValidateParameters method.  
    Public MethodValidateParametersAsyncExNon-blocking (asynchronous) version of the ValidateParameters method.  
    Top
    Protected Methods
     NameDescription
    Protected MethodCreateParametersCollectionCreates the ParameterCollection object.  
    Protected MethodFinalize (Inherited from System.ComponentModel.Component)
    Protected MethodFirePageCountChangedFor internal use.  
    Protected MethodGetService (Inherited from System.ComponentModel.Component)
    Protected MethodInitCalled from constructor, initializes an object.  
    Protected MethodMemberwiseCloneOverloaded.  (Inherited from System.MarshalByRefObject)
    Protected MethodOnBusyStateChangedFor internal use.  
    Protected MethodOnDirtyChangedFor internal use.  
    Protected MethodOnExportCompletedFor internal use.  
    Protected MethodOnGenerateCompletedFor internal use.  
    Protected MethodOnGetLinkTargetPositionCompletedFor internal use.  
    Protected MethodOnGetPageCompletedFor internal use.  
    Protected MethodOnPageCountChangedFor internal use.  
    Protected MethodOnPagesClearFor internal use.  
    Protected MethodOnPagesLoadedFor internal use.  
    Protected MethodOnSecurityErrorFor internal use.  
    Protected MethodOnValidateParametersCompletedFor internal use.  
    Top
    Public Events
     NameDescription
    Public EventBusyStateChangedOccurs when the BusyState property value changes.  
    Public EventDirtyChangedOccurs when the Dirty property value changes.  
    Public EventDisposed (Inherited from System.ComponentModel.Component)
    Public EventExportCompletedOccurs when the ExportAsync method has completed.  
    Public EventGenerateCompletedOccurs when the GenerateAsync method has completed.  
    Public EventLongOperationOccurs periodically during various document operations. Allows to provide progress indication and the ability to cancel some long operations such as document generation.  
    Public EventPageCountChangedOccurs when the PageCount property value changes.  
    Public EventSecurityErrorOccurs 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 EventValidateParametersCompletedOccurs when the ValidateParametersAsync method has completed.  
    Top
    See Also

    Reference

    C1DocumentSource Class
    C1.Win.Document Namespace