TX Text Control .NET Server

FilterException Class

Class|Introduced in 24.0
Namespace
TXTextControl
Package
TXTextControl.TextControl.Core.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.Core.dll
Install
dotnet add package TXTextControl.TextControl.Core.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.dll from the setup.
Also in
TXTextControl.TextControl.ASP.SDK as TXTextControl.dll
Inherits
  1. Exception
  2. FilterException

Description

The FilterException class informs about errors which can occur when a text filter is used to convert a document to or from another format.

Syntax

public class FilterException : Exception

Examples

The following example creates a Filter Exception instance and configures its help link setting for a document workflow.

FilterException filterException = new(FilterException.FilterError.WrongFileType);
filterException.HelpLink = "Quarterly report";

Members

Constructors

ConstructorDescription
FilterExceptionInitializes a new instance of the FilterException class.

Properties

PropertyDescription
ReasonGets the error which is the cause of this exception. It can be one of the FilterException.FilterError values.

Enumerations

EnumerationDescription
FilterErrorEnumerates errors which can occur when a text filter is used to convert a TX Text Control document to or from another format. It contains the following values: