NoteCollection.BeginUpdateSeparator(NoteSeparatorType) Method

Opens the specified separator for editing.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

SubDocument BeginUpdateSeparator(
    NoteSeparatorType type
)

VB.NET

Function BeginUpdateSeparator(
    type As NoteSeparatorType
) As SubDocument

Parameters

Name	Type	Description
type	NoteSeparatorType	A separator type

Returns

Type	Description
SubDocument	An object that contains the separator content.

Remarks

Use the NoteCollection.BeginUpdateSeparator - NoteCollection.EndUpdateSeparator paired methods to update one of the note separators (separator, continuation separator, or continuation notice).

If the document does not contain the specified separator, the NoteCollection.BeginUpdateSeparator method call creates a new separator. Call the NoteCollection.HasSeparator method to determine whether notes already have a specified separator type.

The code sample below shows how to change the footnote separator:

C#

RichEditDocumentServer wordProcessor = new RichEditDocumentServer();
wordProcessor.LoadDocument("Documents//Grimm.docx");
Document document = wordProcessor.Document;
if (document.Footnotes.HasSeparator(NoteSeparatorType.Separator))
{
    SubDocument noteSeparator = document.Footnotes.BeginUpdateSeparator(NoteSeparatorType.Separator);
    noteSeparator.Delete(noteSeparator.Range);
    noteSeparator.AppendText("***");
    document.Footnotes.EndUpdateSeparator(noteSeparator);
}

VB.NET

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

If document.Footnotes.HasSeparator(NoteSeparatorType.Separator) Then
    Dim noteSeparator As SubDocument = document.Footnotes.BeginUpdateSeparator(NoteSeparatorType.Separator)
    noteSeparator.Delete(noteSeparator.Range)
    noteSeparator.AppendText("***")
    document.Footnotes.EndUpdateSeparator(noteSeparator)
End If

Related GitHub Examples

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

//Initiate the update session:
SubDocument noteSeparator = document.Footnotes.BeginUpdateSeparator(NoteSeparatorType.Separator);

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

//Initiate the update session:
SubDocument noteSeparator = document.Footnotes.BeginUpdateSeparator(NoteSeparatorType.Separator);

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

// Access the footnote separator.
SubDocument noteSeparator = document.Footnotes.BeginUpdateSeparator(NoteSeparatorType.Separator);

VB.NET

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

'Initiate the update session:
Dim noteSeparator As SubDocument = document.Footnotes.BeginUpdateSeparator(NoteSeparatorType.Separator)

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

'Initiate the update session:
Dim noteSeparator As DevExpress.XtraRichEdit.API.Native.SubDocument = document.Footnotes.BeginUpdateSeparator(DevExpress.XtraRichEdit.API.Native.NoteSeparatorType.Separator)
'Clear the separator range:

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

' Access the footnote separator.
Dim noteSeparator As DevExpress.XtraRichEdit.API.Native.SubDocument = document.Footnotes.BeginUpdateSeparator(DevExpress.XtraRichEdit.API.Native.NoteSeparatorType.Separator)
' Clear the separator range.