FieldOptions.ThrowExceptionOnInvalidFormatSwitch Property

Gets or sets whether to throw exception if a field formatting switch is not recognized.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v20.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

[DefaultValue(true)]
public bool ThrowExceptionOnInvalidFormatSwitch { get; set; }

VB.NET

<DefaultValue(True)>
Public Property ThrowExceptionOnInvalidFormatSwitch As Boolean

Property Value

Type	Default	Description
Boolean	**true**	True, to throw exception on an invalid field formatting switch; otherwise, false.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to ThrowExceptionOnInvalidFormatSwitch
WinForms Controls	SnapControlOptions	.Fields .ThrowExceptionOnInvalidFormatSwitch
	RichEditControlOptions	.Fields .ThrowExceptionOnInvalidFormatSwitch
WPF Controls	RichEditControlOptions	.Fields .ThrowExceptionOnInvalidFormatSwitch
Office File API	RichEditControlOptionsBase	.Fields .ThrowExceptionOnInvalidFormatSwitch

Remarks

The field update starts by parsing the Field.CodeRange content to obtain the field name and the field switches. If an attempt to recognize the field formatting switch fails with an exception, you can prevent the exception from propagation by setting the ThrowExceptionOnInvalidFormatSwitch property to false. In this situation, the field is calculated but the formatting switch is ignored.

Tip

Set the ThrowExceptionOnInvalidFormatSwitch property to false to open documents containing incorrect field codes.