TX Text Control .NET for Windows Forms

DataSourceExtractionDialog Class

Class|Introduced in 24.0
Namespace
TXTextControl.DocumentServer.Windows.Forms
Package
TXTextControl.TextControl.WinForms.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXDocumentServer.Windows.Forms.dll
Install
dotnet add package TXTextControl.TextControl.WinForms.SDK .NET 8 and later. For .NET Framework, reference TXDocumentServer.Windows.Forms.dll from the setup.
Inherits
  1. Form
  2. HighDpiForm
  3. DataSourceExtractionDialog

Description

The DataSourceExtractionDialog class allows the user to save an excerpt from the currently loaded data source. An upper limit of extracted data rows can be specified in the dialog. It works only with data provider based data sources and throws an exception when called with any other loaded data source type. The DataSourceExtractionDialog is a modal dialog box which must be shown with the DataSourceExtractionDialog.ShowDialog method.

Syntax

public class DataSourceExtractionDialog : HighDpiForm

Examples

The following example creates a Data Source Extraction Dialog instance and configures its allow transparency setting for a document workflow.

using TXTextControl.DocumentServer.Windows.Forms.DataSourceExtractionDialog dataSourceExtractionDialog = new(new TXTextControl.DocumentServer.DataSources.DataSourceManager());
dataSourceExtractionDialog.AllowTransparency = true;

Members

Constructors

ConstructorDescription
DataSourceExtractionDialogCreates a DataSourceExtractionDialog object for the specified DocumentServer.DataSources.DataSourceManager.

Properties

PropertyDescription
FileNameReturns the file name of the file into which the data source excerpt has been saved.
MaxRowsReturns the maximum number of data rows from the selected table which were saved into the excerpt file.
SelectedTableReturns a description of the table which was selected by the user to be exported.

Methods

MethodDescription
ShowNot described in the reference. public void Show(IWin32Window owner);
ShowDialogNot described in the reference. public System.Windows.Forms.DialogResult ShowDialog();