FieldCollection.Add(DocumentPosition, String) Method

OBSOLETE

This method has become obsolete. Use the 'Create' method instead.

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

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

[Obsolete("This method has become obsolete. Use the 'Create' method instead.")]
Field Add(
    DocumentPosition start,
    string code
)

VB.NET

<Obsolete("This method has become obsolete. Use the 'Create' method instead.")>
Function Add(
    start As DocumentPosition,
    code As String
) As Field

Parameters

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

Returns

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

Remarks

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

Related GitHub Examples

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

generating-table-of-contents-toc-practical-guide-e4138/CS/Form1.cs#L62

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

how-to-customize-the-insert-merge-field-menu-e4177/CS/CustomInsertMergeFieldItem.cs#L155

protected override void OnClick(BarItemLink link) {
    control.Document.Fields.Add(control.Document.CaretPosition, string.Format(" MERGEFIELD {0} ", this.fieldName));
}

how-to-create-an-editor-similar-to-outlook-attachment-editor-e4911/CS/WindowsFormsApplication1/WindowsFormsApplication1/AttachmentsEditor.cs#L39

}
richEditControl1.Document.Fields.Add(richEditControl1.Document.Range.End, "DOCVARIABLE " + openFileDialog.SafeFileName);
filesCollection.Add(openFileDialog.SafeFileName, new FileFieldInfo() { DocField = richEditControl1.Document.Fields[richEditControl1.Document.Fields.Count - 1], FileName = openFileDialog.SafeFileName, FullFileName = openFileDialog.FileName });

how-to-generate-table-of-content-automatically-based-on-some-datasource-records-e5011/CS/WindowsFormsApplication1/Form1.cs#L50

void InsertTOC(string switches) {
    Field field = richEditControl1.Document.Fields.Add(richEditControl1.Document.Range.Start, "TOC " + switches);
    CharacterProperties cp = richEditControl1.Document.BeginUpdateCharacters(field.Range);

VB.NET

generating-table-of-contents-toc-practical-guide-e4138/VB/Form1.vb#L77

Private Function AnonymousMethod3(ByVal location As DocumentPosition, ByVal level As Integer) As Boolean
    Document.Fields.Add(location, String.Format("TC ""{0}"" \f {1} \l {2}", Document.GetText(Document.GetParagraph(location).Range), "defaultGroup", level))
    Return True

how-to-customize-the-insert-merge-field-menu-e4177/VB/CustomInsertMergeFieldItem.vb#L186

Protected Overrides Sub OnClick(ByVal link As BarItemLink)
    control.Document.Fields.Add(control.Document.CaretPosition, String.Format(" MERGEFIELD {0} ", Me.fieldName))
End Sub

how-to-create-an-editor-similar-to-outlook-attachment-editor-e4911/VB/WindowsFormsApplication1/AttachmentsEditor.vb#L42

End If
richEditControl1.Document.Fields.Add(richEditControl1.Document.Range.End, "DOCVARIABLE " & openFileDialog.SafeFileName)
filesCollection.Add(openFileDialog.SafeFileName, New FileFieldInfo() With {.DocField = richEditControl1.Document.Fields(richEditControl1.Document.Fields.Count - 1), .FileName = openFileDialog.SafeFileName, .FullFileName = openFileDialog.FileName})

how-to-generate-table-of-content-automatically-based-on-some-datasource-records-e5011/VB/WindowsFormsApplication1/Form1.vb#L50

Private Sub InsertTOC(ByVal switches As String)
    Dim field As Field = richEditControl1.Document.Fields.Add(richEditControl1.Document.Range.Start, "TOC " & switches)
    Dim cp As CharacterProperties = richEditControl1.Document.BeginUpdateCharacters(field.Range)