Skip to main content
.NET Framework 4.5.2+

NoteCollection.BeginUpdateSeparator(NoteSeparatorType) Method

Opens the specified separator for editing.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

SubDocument BeginUpdateSeparator(
    NoteSeparatorType type
)

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:

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);
}

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.

See Also