NoteCollection.HasSeparator(NoteSeparatorType) Method

Determines whether notes have the specified separator type.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

bool HasSeparator(
    NoteSeparatorType type
)

VB.NET

Function HasSeparator(
    type As NoteSeparatorType
) As Boolean

Parameters

Name	Type	Description
type	NoteSeparatorType	The separator type.

Returns

Type	Description
Boolean	true if the separator type exists; otherwise, false.

Remarks

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

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

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 HasSeparator(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#L95

//Check whether the footnotes already have a separator:
if (document.Footnotes.HasSeparator(NoteSeparatorType.Separator))
{

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

//Check whether the footnotes already have a separator:
if (document.Footnotes.HasSeparator(NoteSeparatorType.Separator))
{

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

// Check whether footnotes already have a separator.
if (document.Footnotes.HasSeparator(NoteSeparatorType.Separator))
{

VB.NET

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

'Check whether the footnotes already have a separator:
If document.Footnotes.HasSeparator(NoteSeparatorType.Separator) Then
    'Initiate the update session:

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

'Check whether the footnotes already have a separator:
If document.Footnotes.HasSeparator(DevExpress.XtraRichEdit.API.Native.NoteSeparatorType.Separator) Then
    'Initiate the update session:

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

' Check whether footnotes already have a separator.
If document.Footnotes.HasSeparator(DevExpress.XtraRichEdit.API.Native.NoteSeparatorType.Separator) Then
    ' Access the footnote separator.