.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

Section.BeginUpdateHeader(HeaderFooterType) Method

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

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

SubDocument BeginUpdateHeader(
    HeaderFooterType type
)

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

using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
Document document = wordProcessor.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);
    }
}
See Also