Section.BeginUpdateHeader(HeaderFooterType) Method

Starts editing the document’s header of the specified type.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v20.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

SubDocument BeginUpdateHeader(
    HeaderFooterType type
)

VB.NET

Function BeginUpdateHeader(
    type As HeaderFooterType
) As SubDocument

Parameters

Name	Type	Description
type	HeaderFooterType	A HeaderFooterType enumeration value, representing the type of the header open for editing.

Returns

Type	Description
SubDocument	A SubDocument instance representing the header being edited.

Remarks

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

You can use the Section.HasHeader method to determine whether the document already has a header.

Example

View Example

HeaderAndFooterActions.cs

Document document = server.Document;
Section firstSection = document.Sections[0];

// Check whether the document already has a header (the same header for all pages).
if (firstSection.HasHeader(HeaderFooterType.Primary))
{
    //If not, create an empty header
    SubDocument headerDocument = firstSection.BeginUpdateHeader();
    headerDocument.Paragraphs.Append();
    firstSection.EndUpdateHeader(headerDocument);
}

HeaderAndFooterActions.vb

Dim document As Document = server.Document
Dim firstSection As Section = document.Sections(0)

' Check whether the document already has a header (the same header for all pages).
If firstSection.HasHeader(HeaderFooterType.Primary) Then

    ' If not, create an empty header
    Dim headerDocument As SubDocument = firstSection.BeginUpdateHeader()
    headerDocument.Paragraphs.Append()
    firstSection.EndUpdateHeader(headerDocument)
End If

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BeginUpdateHeader(HeaderFooterType) 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-merge-documents-with-headers-and-footers-into-a-single-document-e4404/CS/DocumentMerger/Helpers/SectionsMerger.cs#L29

SubDocument source = sourceSection.BeginUpdateHeader(headerFooterType);
SubDocument target = targetSection.BeginUpdateHeader(headerFooterType);

how-to-display-a-tooltip-when-hovering-with-the-mouse-over-a-particular-word-e3409/CS/Form1.cs#L85

Section firstSection = richEditControl1.Document.Sections[0];
SubDocument doc = firstSection.BeginUpdateHeader(HeaderFooterType.Odd);
doc.InsertText(doc.Range.Start, "Page header");

subdocument-essentials-simple-examples-e2265/CS/SubDocumentExample/Form1.cs#L39

Section firstSection = richEditControl1.Document.Sections[0];
SubDocument doc = firstSection.BeginUpdateHeader(HeaderFooterType.First);
DocumentRange range = doc.InsertText(doc.CreatePosition(0), " PAGE NUMBER ");

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

// Modify the header of the HeaderFooterType.First type.
SubDocument myHeader = firstSection.BeginUpdateHeader(HeaderFooterType.First);
DocumentRange range = myHeader.InsertText(myHeader.CreatePosition(0), " PAGE NUMBER ");

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

// Modify the header of the HeaderFooterType.First type.
SubDocument myHeader = firstSection.BeginUpdateHeader(HeaderFooterType.First);
DocumentRange range = myHeader.InsertText(myHeader.CreatePosition(0), " PAGE NUMBER ");

VB.NET

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

Dim source As SubDocument = sourceSection.BeginUpdateHeader(headerFooterType)
Dim target As SubDocument = targetSection.BeginUpdateHeader(headerFooterType)

how-to-display-a-tooltip-when-hovering-with-the-mouse-over-a-particular-word-e3409/VB/Form1.vb#L90

Dim firstSection As Section = richEditControl1.Document.Sections(0)
Dim doc As SubDocument = firstSection.BeginUpdateHeader(HeaderFooterType.Odd)
doc.InsertText(doc.Range.Start, "Page header")

subdocument-essentials-simple-examples-e2265/VB/SubDocumentExample/Form1.vb#L36

Dim firstSection As Section = richEditControl1.Document.Sections(0)
Dim doc As SubDocument = firstSection.BeginUpdateHeader(HeaderFooterType.First)
Dim range As DocumentRange = doc.InsertText(doc.CreatePosition(0), " PAGE NUMBER ")

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

' Modify the header of the HeaderFooterType.First type.
Dim myHeader As DevExpress.XtraRichEdit.API.Native.SubDocument = firstSection.BeginUpdateHeader(DevExpress.XtraRichEdit.API.Native.HeaderFooterType.First)
Dim range As DevExpress.XtraRichEdit.API.Native.DocumentRange = myHeader.InsertText(myHeader.CreatePosition(0), " PAGE NUMBER ")

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

' 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 ")