TX Text Control .NET Server

SortingInstruction Class

Class|Introduced in 26.0
Namespace
TXTextControl.DocumentServer.DataShaping
Package
TXTextControl.TextControl.Core.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXDocumentServer.Core.dll
Install
dotnet add package TXTextControl.TextControl.Core.SDK .NET 8 and later. For .NET Framework, reference TXDocumentServer.dll from the setup.
Also in
TXTextControl.TextControl.ASP.SDK as TXDocumentServer.dll

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

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";

Members

Constructors

ConstructorDescription
SortingInstructionInitializes a new instance of the SortingInstruction class.

Properties

PropertyDescription
CultureGets or sets the format provider for numerical value comparison. The default value for this property is the invariant culture.
OrderByGets or sets the table column name to order the data by.
SortOrderGets or sets the sort order (ascending / descending).

Further Reading

  • Adding Sorting and Filter Instructions to Existing MergeBlocks –