Document.UnlinkAllFields() Method

Replaces all document fields with field values.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

void UnlinkAllFields()

VB.NET

Sub UnlinkAllFields

Remarks

The Unlink method converts fields’ results to text or graphics. Unlinked fields can not be updated automatically.

Use the Field.Unlink method to unlink a field. The FieldCollection.Unlink method allows you to unlink all fields in specific parts of a document (main body, text box, header, footer, comment, footnote, and endnote).

The code sample below unlinks all fields in the document.

C#

using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
//...

using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
    // Access a document.
    Document document = wordProcessor.Document;
    //...
    // Unlink all fields in the document.
    document.UnlinkAllFields();
}

VB.NET

Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native
'...

Using wordProcessor As New RichEditDocumentServer()
    ' Access a document.
    Dim document As Document = wordProcessor.Document
    '...
    ' Unlink all fields in the document.
    document.UnlinkAllFields()
End Using

Related GitHub Examples

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

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#

how-to-replace-document-fields-with-their-values/CS/Form1.cs#L34

private void FieldsToValues(RichEditControl control) {
    control.Document.UnlinkAllFields();
}

snap-convert-snx-to-repx/CS/SnxToRepx/Converter/SnapReportConverter.cs#L196

//XRPageInfo does not support this, so all fields are converted to static values before processing
server.Document.UnlinkAllFields();
//Specify the current band to place content into

VB.NET

how-to-replace-document-fields-with-their-values/VB/Form1.vb#L32

Private Sub FieldsToValues(ByVal control As RichEditControl)
    control.Document.UnlinkAllFields()
End Sub

snap-convert-snx-to-repx/VB/SnxToRepx/Converter/SnapReportConverter.vb#L168

'XRPageInfo does not support this, so all fields are converted to static values before processing
server.Document.UnlinkAllFields()
'Specify the current band to place content into