FilterAndSortDialog Class
- Namespace
TXTextControl.DocumentServer. Windows. Forms
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WinForms. SDK
- Assembly
TXDocumentServer.Windows. Forms. dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WinForms. SDK TXDocumentServer.from the setup.Windows. Forms. dll
- Inherits
- Form
- HighDpiForm
- Filter
And Sort Dialog
Description
The FilterAndSortDialog class allows the user to specify filters and sorting instructions for merge blocks. The FilterAndSortDialog is a modal dialog box which must be shown with the FilterAndSortDialog.ShowDialog method.
Syntax
public class FilterAndSortDialog : HighDpiFormPublic Class FilterAndSortDialog
Inherits HighDpiFormExamples
The following example creates a Filter And Sort Dialog instance and configures its allow transparency setting for a document workflow.
using TXTextControl.DocumentServer.Windows.Forms.FilterAndSortDialog filterAndSortDialog = new(new string[] { "CustomerName" });
filterAndSortDialog.AllowTransparency = true;Dim filterAndSortDialog As New TXTextControl.DocumentServer.Windows.Forms.FilterAndSortDialog(New String() { "CustomerName" })
filterAndSortDialog.AllowTransparency = TrueMembers
Constructors
| Constructor | Description |
|---|---|
| FilterAndSortDialog | Initializes a new instance of the FilterAndSortDialog class. |
Properties
| Property | Description |
|---|---|
| Filters | Gets the filter instructions which were created using the dialog or sets the filter instructions which are shown when the dialog is opened. |
| SortingInstructions | Gets the sorting instructions which were created using the dialog or sets the sorting instructions which are shown when the dialog is opened. |
Methods
| Method | Description |
|---|---|
| Show | Not described in the reference. public void Show(IWin32Window owner); |
| StoreBlockMetaData | Stores filters and sorting instructions created with the dialog in a SubTextPart object if the SubTextPart is a merge block. Throws an exception if the SubTextPart object is not a merge block. |