Section.BeginUpdateHeader() Method

Starts editing the primary header for the current section.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

SubDocument BeginUpdateHeader()

VB.NET

Function BeginUpdateHeader As SubDocument

Returns

Type	Description
SubDocument	A SubDocument instance that is the header being edited.

Remarks

Use the Section.BeginUpdateHeader - Section.EndUpdateHeader method pair to edit primary (the HeaderFooterType.Primary type) header content. If the document has no header as yet, this method creates a header of the HeaderFooterType.Primary type and opens it for editing.

You can use the Section.HasHeader property to determine whether the document already has a header which is the same for all pages (a header of the HeaderFooterType.Primary type).

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

HeaderAndFooter.vb

Dim firstSection As Section = document.Sections(0)
' Create an empty header.
Dim newHeader As SubDocument = firstSection.BeginUpdateHeader()
firstSection.EndUpdateHeader(newHeader)
' Check whether the document already has a header (the same header for all pages).
If firstSection.HasHeader(HeaderFooterType.Primary) Then
    Dim headerDocument As SubDocument = firstSection.BeginUpdateHeader()
    document.ChangeActiveDocument(headerDocument)
    document.CaretPosition = headerDocument.CreatePosition(0)
    firstSection.EndUpdateHeader(headerDocument)
End If

HeaderAndFooter.cs

Section firstSection = document.Sections[0];
// Create an empty header.
SubDocument newHeader = firstSection.BeginUpdateHeader();
firstSection.EndUpdateHeader(newHeader);
// Check whether the document already has a header (the same header for all pages).
if (firstSection.HasHeader(HeaderFooterType.Primary))
{
    SubDocument headerDocument = firstSection.BeginUpdateHeader();
    document.ChangeActiveDocument(headerDocument);
    document.CaretPosition = headerDocument.CreatePosition(0);
    firstSection.EndUpdateHeader(headerDocument);
}

Related GitHub Examples

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

how-to-add-remove-a-specific-watermark-only-for-a-particular-section-of-the-richeditcontrols-e4901/CS/WindowsFormsApplication1/Form1.cs#L50

Section currentSection = GetCurrentSection();
SubDocument subDocument = currentSection.BeginUpdateHeader();
subDocument.Delete(subDocument.Range);

how-to-add-a-watermark-with-a-text-or-image-to-the-document-e4184/CS/Form1.cs#L27

Section section = richEditControl.Document.Sections[0];
SubDocument subDocument = section.BeginUpdateHeader();
subDocument.Delete(subDocument.Range);

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/HeaderAndFooterActions.cs#L17

// Create an empty header.
SubDocument newHeader = firstSection.BeginUpdateHeader();
firstSection.EndUpdateHeader(newHeader);

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/HeaderAndFooter.cs#L17

// Create an empty header.
SubDocument newHeader = firstSection.BeginUpdateHeader();
firstSection.EndUpdateHeader(newHeader);

word-document-api-examples/CS/CodeExamples/HeaderAndFooterActions.cs#L15

// Create an empty header.
SubDocument newHeader = firstSection.BeginUpdateHeader();
firstSection.EndUpdateHeader(newHeader);

VB.NET

how-to-add-remove-a-specific-watermark-only-for-a-particular-section-of-the-richeditcontrols-e4901/VB/WindowsFormsApplication1/Form1.vb#L52

Dim currentSection As Section = GetCurrentSection()
Dim subDocument As SubDocument = currentSection.BeginUpdateHeader()
subDocument.Delete(subDocument.Range)

how-to-add-a-watermark-with-a-text-or-image-to-the-document-e4184/VB/Form1.vb#L29

Dim section As Section = richEditControl.Document.Sections(0)
Dim subDocument As SubDocument = section.BeginUpdateHeader()
subDocument.Delete(subDocument.Range)

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/HeaderAndFooterActions.vb#L14

' Create an empty header.
Dim newHeader As SubDocument = firstSection.BeginUpdateHeader()
firstSection.EndUpdateHeader(newHeader)

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/HeaderAndFooter.vb#L14

' Create an empty header.
Dim newHeader As SubDocument = firstSection.BeginUpdateHeader()
firstSection.EndUpdateHeader(newHeader)

word-document-api-examples/VB/CodeExamples/HeaderAndFooterActions.vb#L12

' Create an empty header.
Dim newHeader As SubDocument = firstSection.BeginUpdateHeader()
firstSection.EndUpdateHeader(newHeader)