SortingInstruction Class

Class|Introduced in 26.0

Namespace: TXTextControl.DocumentServer.DataShaping

Package: TXTextControl.TextControl.WPF.SDK from the private NuGet feed or Text Control Offline Packages

Assembly: TXDocumentServer.dll

Install: dotnet add package TXTextControl.TextControl.WPF.SDK .NET 8 and later. For .NET Framework, reference TXDocumentServer.dll from the setup.

Description

The SortingInstruction class contains merge block data sorting information such as the sort order and the column name to sort the data rows after. It is used by the MergeBlockInfo class.

Syntax

public class SortingInstruction

Public Class SortingInstruction

Examples

The following example creates a Sorting Instruction instance and configures its order by setting for a document workflow.

TXTextControl.DocumentServer.DataShaping.SortingInstruction sortingInstruction = new("Quarterly report");
sortingInstruction.OrderBy = "Quarterly report";

Dim sortingInstruction As New TXTextControl.DocumentServer.DataShaping.SortingInstruction("Quarterly report")
sortingInstruction.OrderBy = "Quarterly report"

Members

Constructors

Constructor	Description
SortingInstruction	Initializes a new instance of the SortingInstruction class.

Properties

Property	Description
Culture	Gets or sets the format provider for numerical value comparison. The default value for this property is the invariant culture.
OrderBy	Gets or sets the table column name to order the data by.
SortOrder	Gets or sets the sort order (ascending / descending).