Section.EndUpdateHeader(SubDocument) Method

Finalizes editing of the section’s header.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

void EndUpdateHeader(
    SubDocument document
)

VB.NET

Sub EndUpdateHeader(
    document As SubDocument
)

Parameters

Name	Type	Description
document	SubDocument	A SubDocument instance, representing the header open for editing.

Remarks

Use the Section.BeginUpdateHeader - Section.EndUpdateHeader method pair to edit header content.

Example

The following code snippet opens the first section’s header for editing. The header type is HeaderFooterType.First, so it is displayed for the first page only if the corresponding mode is enabled (use the Section.DifferentFirstPage property). Then, the text string and a PAGE field are inserted and the Section.EndUpdateHeader method is called to finalize the modification.

Note

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

HeaderAndFooter.vb

document.AppendSection()
Dim firstSection As Section = document.Sections(0)
' Modify the header of the HeaderFooterType.First type.
Dim myHeader As SubDocument = firstSection.BeginUpdateHeader(HeaderFooterType.First)
Dim range As DocumentRange = myHeader.InsertText(myHeader.CreatePosition(0), " PAGE NUMBER ")
Dim fld As Field = myHeader.Fields.Create(range.End, "PAGE \* ARABICDASH")
myHeader.Fields.Update()
firstSection.EndUpdateHeader(myHeader)
' Display the header of the HeaderFooterType.First type on the first page.
firstSection.DifferentFirstPage = True

HeaderAndFooter.cs

document.AppendSection();
Section firstSection = document.Sections[0];
// Modify the header of the HeaderFooterType.First type.
SubDocument myHeader = firstSection.BeginUpdateHeader(HeaderFooterType.First);
DocumentRange range = myHeader.InsertText(myHeader.CreatePosition(0), " PAGE NUMBER ");
Field fld = myHeader.Fields.Create(range.End, "PAGE \\* ARABICDASH");
myHeader.Fields.Update();
firstSection.EndUpdateHeader(myHeader);
// Display the header of the HeaderFooterType.First type on the first page.
firstSection.DifferentFirstPage = true;

Related GitHub Examples

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

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

SubDocument newHeader = firstSection.BeginUpdateHeader();
firstSection.EndUpdateHeader(newHeader);
// Check whether the document already has a header (the same header for all pages).

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

SubDocument newHeader = firstSection.BeginUpdateHeader();
firstSection.EndUpdateHeader(newHeader);
// Check whether the document already has a header (the same header for all pages).

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

SubDocument newHeader = firstSection.BeginUpdateHeader();
firstSection.EndUpdateHeader(newHeader);
// Check whether the document already has a header (the same header for all pages).

how-to-merge-documents-with-headers-and-footers-into-a-single-document-e4404/CS/DocumentMerger/Helpers/SectionsMerger.cs#L32

sourceSection.EndUpdateHeader(source);
targetSection.EndUpdateHeader(target);

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

    shape.Offset = new PointF(Convert.ToInt64(currentSection.Page.Width) / 2 - Convert.ToInt64(shape.Size.Width) / 2, Convert.ToInt64(currentSection.Page.Height) / 2 - Convert.ToInt64(shape.Size.Height) / 2);
    currentSection.EndUpdateHeader(subDocument);
}

VB.NET

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

Dim newHeader As SubDocument = firstSection.BeginUpdateHeader()
firstSection.EndUpdateHeader(newHeader)
' Check whether the document already has a header (the same header for all pages).

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

Dim newHeader As SubDocument = firstSection.BeginUpdateHeader()
firstSection.EndUpdateHeader(newHeader)
' Check whether the document already has a header (the same header for all pages).

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

Dim newHeader As SubDocument = firstSection.BeginUpdateHeader()
firstSection.EndUpdateHeader(newHeader)
' Check whether the document already has a header (the same header for all pages).

how-to-merge-documents-with-headers-and-footers-into-a-single-document-e4404/VB/DocumentMerger/Helpers/SectionsMerger.vb#L34

sourceSection.EndUpdateHeader(source)
targetSection.EndUpdateHeader(target)

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

    shape.Offset = New PointF(Convert.ToInt64(currentSection.Page.Width) \ 2 - Convert.ToInt64(shape.Size.Width) \ 2, Convert.ToInt64(currentSection.Page.Height) \ 2 - Convert.ToInt64(shape.Size.Height) \ 2)
    currentSection.EndUpdateHeader(subDocument)
End Sub