FieldCollection.Create(DocumentPosition, String) Method

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

Namespace: DevExpress.XtraRichEdit.API.Native

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

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.

Remarks

Use the Create method to insert a new field in a document.

This code snippet inserts the DATE field at the caret position.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

Field.vb

'Start updating the document
document.BeginUpdate()

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

'Finalize the modification
document.EndUpdate()

Field.cs

//Start updating the document
document.BeginUpdate();

//Create a DATE field at the caret position
document.Fields.Create(document.CaretPosition, "DATE");
document.Fields.Update();

//Finalize the modification
document.EndUpdate();

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-e5219/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-t213968/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#L18

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

how-to-manually-create-a-table-of-contents-t488553/CS/TableOfContentsExample/MainWindow.xaml.cs#L35

    //Mark the captions with the SEQ fields
    Field field = document.Fields.Create(range.End, "SEQ  Image \\*ARABIC");
}

how-to-create-table-of-figures-and-table-of-tables-programmatically-t437901/CS/InsertTableSample/Form1.cs#L38

document.BeginUpdate();
Field field = document.Fields.Create(document.Range.Start, string.Format("TOC \\h \\c \"{0}\"", key));
field.Update();

VB.NET

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/DocumentProperties.vb#L19

document.Fields.Create(document.AppendText(vbLf & "AUTHOR: ").End, "AUTHOR")
document.Fields.Create(document.AppendText(vbLf & "TITLE: ").End, "TITLE")

wpf-richedit-document-api-t213968/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#L15

    document.BeginUpdate()
document.Fields.Create(document.Range.Start, "DATE")
    document.Fields.Update()

how-to-manually-create-a-table-of-contents-t488553/VB/TableOfContentsExample/MainWindow.xaml.vb#L32

    'Mark the captions with the SEQ fields
    Dim field As Field = document.Fields.Create(range.End, "SEQ  Image \*ARABIC")
Next i

how-to-create-table-of-figures-and-table-of-tables-programmatically-t437901/VB/InsertTableSample/Form1.vb#L34

document.BeginUpdate()
Dim field As Field = document.Fields.Create(document.Range.Start, String.Format("TOC \h \c ""{0}""", key))
field.Update()