FieldCollection.Create(DocumentPosition, String) Method

Adds a field specified by its code to the field collection.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

Field Create(
    DocumentPosition start,
    string code
)

VB.NET

Function Create(
    start As DocumentPosition,
    code As String
) As Field

Parameters

Name	Type	Description
start	DocumentPosition	A DocumentPosition at which the field is inserted.
code	String	A string specifying the field’s code.

Returns

Type	Description
Field	A Field object specifying the newly created field.

Example

The code snippet below uses the SYMBOL field to add a check mark (✔) to the document:

C#

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

using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
    // Access a document.
    Document document = wordProcessor.Document;

    // Start to edit the document.
    document.BeginUpdate();

    // Create the "SYMBOL" field.
    document.Fields.Create(document.Range.Start, "SYMBOL 252 \\f Wingdings \\s 28");

    // Finalize to edit the document.
    document.EndUpdate();

    // Update all fields in the main document body.
    document.Fields.Update();

    // Save the document to the file.
    document.SaveDocument("Result.docx", DocumentFormat.OpenXml);
}

VB.NET

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

Using wordProcessor As New RichEditDocumentServer()
    ' Access a document.
    Dim document As Document = wordProcessor.Document

    ' Start to edit the document.
    document.BeginUpdate()

    ' Create the "SYMBOL" field.
    document.Fields.Create(document.Range.Start, "SYMBOL 252 \f Wingdings \s 28")

    ' Finalize to edit the document.
    document.EndUpdate()

    ' Update all fields in the main document body.
    document.Fields.Update()

    ' Save the document to the file.
    document.SaveDocument("Result.docx", DocumentFormat.OpenXml)
End Using

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Create(DocumentPosition, String) 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#

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/DocumentProperties.cs#L20

document.Fields.Create(document.AppendText("\nAUTHOR: ").End, "AUTHOR");
document.Fields.Create(document.AppendText("\nTITLE: ").End, "TITLE");

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/DocumentFieldActions.cs#L16

document.BeginUpdate();
document.Fields.Create(document.CaretPosition, "DATE");
document.Fields.Update();

word-document-api-examples/CS/CodeExamples/FieldActions.cs#L28

// Create the "DATE" field.
document.Fields.Create(document.Range.Start, "DATE");

winforms-richedit-utility-to-create-a-mail-merge-template/CS/Form1.cs#L33

private void barButtonItem2_ItemClick(object sender, DevExpress.XtraBars.ItemClickEventArgs e) {
    richEditControl1.Document.Fields.Create(richEditControl1.Document.CaretPosition, " DOCVARIABLE dvField ");
}

winforms-richedit-table-of-contents-practical-guide/CS/Form1.cs#L63

SearchForTOCEntries(delegate(DocumentPosition location, int level) {
    Document.Fields.Create(location, string.Format("TC \"{0}\" \\f {1} \\l {2}",
        Document.GetText(Document.Paragraphs.Get(location).Range), "defaultGroup", level));

VB.NET

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Field.vb#L18

'Create a DATE field at the caret position
document.Fields.Create(caretPosition, "DATE")
document.Fields.Update()

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/DocumentFieldActions.vb#L13

document.BeginUpdate()
document.Fields.Create(document.CaretPosition, "DATE")
document.Fields.Update()

word-document-api-examples/VB/CodeExamples/FieldActions.vb#L28

' Create the "DATE" field.
document.Fields.Create(document.Range.Start, "DATE")
' Update all fields in the main document body.

winforms-richedit-utility-to-create-a-mail-merge-template/VB/Form1.vb#L35

Private Sub barButtonItem2_ItemClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs) Handles barButtonItem2.ItemClick
    richEditControl1.Document.Fields.Create(richEditControl1.Document.CaretPosition, " DOCVARIABLE dvField ")
End Sub

winforms-richedit-table-of-contents-practical-guide/VB/Form1.vb#L66

Private Sub AddTCFields()
    SearchForTOCEntries(Sub(ByVal location, ByVal level) Document.Fields.Create(location, String.Format("TC ""{0}"" \f {1} \l {2}", Document.GetText(Document.Paragraphs.Get(location).Range), "defaultGroup", level)))
End Sub