PlainTextDocumentExporterOptions.FieldCodeStartMarker Property

Gets or sets a character or a string used to mark the start of a field code in the resulting text.

Namespace: DevExpress.XtraRichEdit.Export

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

[DefaultValue("")]
public string FieldCodeStartMarker { get; set; }

VB.NET

<DefaultValue("")>
Public Property FieldCodeStartMarker As String

Property Value

Type	Default	Description
String	String.Empty	A string that marks the beginning of the field code.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to FieldCodeStartMarker
WinForms Controls	RichTextEditDocumentExportOptions	.PlainText.FieldCodeStartMarker
Office File API	RichEditDocumentExportOptions	.PlainText.FieldCodeStartMarker

Remarks

To export field codes, set the PlainTextDocumentExporterOptions.ExportHiddenText property to true.

Examples of use of the FieldCodeStartMarker property can be found in the PlainTextDocumentExporterOptions topic and in the SubDocument.GetText method overload topics.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FieldCodeStartMarker property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

exploring-plain-text-exporter-options-e2773/CS/PlainTextExport/Form1.cs#L21

richEditControl1.Options.Export.PlainText.ExportHiddenText = true;
richEditControl1.Options.Export.PlainText.FieldCodeStartMarker = "[<";
richEditControl1.Options.Export.PlainText.FieldCodeEndMarker = ">";

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/Export.cs#L85

exportOptions.ExportHiddenText = true;
exportOptions.FieldCodeStartMarker = "[<";
exportOptions.FieldCodeEndMarker = ">";

VB.NET

exploring-plain-text-exporter-options-e2773/VB/PlainTextExport/Form1.vb#L21

richEditControl1.Options.Export.PlainText.ExportHiddenText = True
richEditControl1.Options.Export.PlainText.FieldCodeStartMarker = "[<"
richEditControl1.Options.Export.PlainText.FieldCodeEndMarker = ">"

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/Export.vb#L78

exportOptions.ExportHiddenText = True
exportOptions.FieldCodeStartMarker = "[<"
exportOptions.FieldCodeEndMarker = ">"