Section.EndUpdateHeader(SubDocument) Method

Finalizes editing of the section’s header.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

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

View Example

HeaderAndFooterActions.cs

Document document = server.Document;
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;

HeaderAndFooterActions.vb

Dim document As Document = server.Document
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

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#

wpf-richedit-document-api/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).

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

    headerDocument.AppendText("Header");
    firstSection.EndUpdateHeader(headerDocument);
}

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

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

how-to-add-a-watermark-to-the-document/CS/Form1.cs#L44

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

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

    newHeader.AppendText("Header");
    firstSection.EndUpdateHeader(newHeader);
}

VB.NET

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

    newHeader.AppendText("Header")
    firstSection.EndUpdateHeader(newHeader)
End If

wpf-richedit-document-api/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).

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

    headerDocument.AppendText("Header")
    firstSection.EndUpdateHeader(headerDocument)
End If

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

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

how-to-add-a-watermark-to-the-document/VB/Form1.vb#L46

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