NoteCollection.Insert(DocumentPosition, String) Method

Inserts a new note into the specific document position with a custom mark.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

Note Insert(
    DocumentPosition position,
    string customMark
)

VB.NET

Function Insert(
    position As DocumentPosition,
    customMark As String
) As Note

Parameters

Name	Type	Description
position	DocumentPosition	A document position to insert a reference into.
customMark	String	A format string for the symbol used to mark the reference.

Returns

Type	Description
Note	A note (footnote or endnote).

Remarks

A custom reference mark representation depends on the font applied to the reference range.

The code sample below shows how to insert a footnote and an endnote with a custom mark:

C#

RichEditDocumentServer wordProcessor = new RichEditDocumentServer();
wordProcessor.LoadDocument("Document.docx");
Document document = wordProcessor.Document;

//Insert a footnote with a ` custom mark:
DocumentPosition footnoteWithCustomMarkPosition = document.CreatePosition(document.Paragraphs[7].Range.End.ToInt() - 1);
document.Footnotes.Insert(footnoteWithCustomMarkPosition, "\u00BA");

//Insert an endnote with a º custom mark:
DocumentPosition endnoteWithCustomMarkPosition = document.CreatePosition(document.Paragraphs[document.Paragraphs.Count - 2].Range.End.ToInt() - 1);
document.Endnotes.Insert(endnoteWithCustomMarkPosition, "\u0060");

VB.NET

Dim wordProcessor As New RichEditDocumentServer()
wordProcessor.LoadDocument("Document.docx")
Dim document As Document = wordProcessor.Document

'Insert a footnote with a ` custom mark:
Dim footnoteWithCustomMarkPosition As DocumentPosition = document.CreatePosition(document.Paragraphs(7).Range.End.ToInt() - 1)
document.Footnotes.Insert(footnoteWithCustomMarkPosition, ChrW(&H00BA).ToString())

'Insert an endnote with a º custom mark:
Dim endnoteWithCustomMarkPosition As DocumentPosition = document.CreatePosition(document.Paragraphs(document.Paragraphs.Count - 2).Range.End.ToInt() - 1)
document.Endnotes.Insert(endnoteWithCustomMarkPosition, ChrW(&H0060).ToString())

Related GitHub Examples

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

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/NotesActions.cs#L20

DocumentPosition footnoteWithCustomMarkPosition = document.CreatePosition(document.Paragraphs[7].Range.End.ToInt() - 1);
document.Footnotes.Insert(footnoteWithCustomMarkPosition, "\u00BA");
#endregion #InsertFootnotes

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

DocumentPosition footnoteWithCustomMarkPosition = document.CreatePosition(document.Paragraphs[7].Range.End.ToInt() - 1);
document.Footnotes.Insert(footnoteWithCustomMarkPosition, "\u00BA");
#endregion #InsertFootnotes

word-document-api-examples/CS/CodeExamples/NotesActions.cs#L32

    DocumentPosition footnoteWithCustomMarkPosition = document.CreatePosition(document.Paragraphs[7].Range.End.ToInt() - 1);
    document.Footnotes.Insert(footnoteWithCustomMarkPosition, "\u00BA");
}

VB.NET

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/NotesActions.vb#L17

            Dim footnoteWithCustomMarkPosition As DocumentPosition = document.CreatePosition(document.Paragraphs(7).Range.End.ToInt() - 1)
            document.Footnotes.Insert(footnoteWithCustomMarkPosition, ChrW(&H00BA).ToString())
'            #End Region ' #InsertFootnotes

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Notes.vb#L16

            Dim footnoteWithCustomMarkPosition As DevExpress.XtraRichEdit.API.Native.DocumentPosition = document.CreatePosition(document.Paragraphs(CInt((7))).Range.[End].ToInt() - 1)
            document.Footnotes.Insert(footnoteWithCustomMarkPosition, "º")
#End Region  ' #InsertFootnotes

word-document-api-examples/VB/CodeExamples/NotesActions.vb#L33

    Dim footnoteWithCustomMarkPosition As DevExpress.XtraRichEdit.API.Native.DocumentPosition = document.CreatePosition(document.Paragraphs(CInt((7))).Range.[End].ToInt() - 1)
    document.Footnotes.Insert(footnoteWithCustomMarkPosition, "º")
End If