Section.HasHeader(HeaderFooterType) Method

Gets whether a section has a header of the specified type.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

bool HasHeader(
    HeaderFooterType type
)

VB.NET

Function HasHeader(
    type As HeaderFooterType
) As Boolean

Parameters

Name	Type	Description
type	HeaderFooterType	A HeaderFooterType enumeration value specifying the header type.

Returns

Type	Description
Boolean	true, if the section has a header of the specified type; otherwise, false.

Remarks

When a new header is created using the Section.BeginUpdateHeader method without arguments, it is the header of the HeaderFooterType.Primary type which is the same for all pages, unless the Section.DifferentFirstPage or the Document.DifferentOddAndEvenPages properties are set to true. So in this situation, you can use the HasHeader method to check for the HeaderFooterType.Primary header type.

Example

View Example

HeaderAndFooterActions.cs

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);
    }
}

HeaderAndFooterActions.vb

Using wordProcessor As New RichEditDocumentServer()
Dim document As Document = wordProcessor.Document
    Dim firstSection As Section = document.Sections(0)

    ' Check whether the document already has a header (the same header for all pages).
    If Not 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
End Using

Related GitHub Examples

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

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/WatermarkActions.cs#L19

{
    if (!section.HasHeader(HeaderFooterType.Primary))
    {

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

// Check whether the document already has a header (the same header for all pages).
if (!firstSection.HasHeader(HeaderFooterType.Primary))
{

word-processing-merge-documents-with-different-headers-and-footers/CS/DocumentMerger/Helpers/SectionsMerger.cs#L27

private static void AppendHeader(Section sourceSection, Section targetSection, HeaderFooterType headerFooterType) {
    if (!sourceSection.HasHeader(headerFooterType)) return;

winforms-rich-edit-iterate-through-all-sub-documents/CS/SubDocumentIterator/SubDocumentHelper.cs#L27

{
    if (section.HasHeader(headerFooterType))
    {

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

// Check whether the document already has a header (the same header for all pages).
if (!firstSection.HasHeader(HeaderFooterType.Primary))
{

VB.NET

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

' Check whether the document already has a header (the same header for all pages).
If Not firstSection.HasHeader(DevExpress.XtraRichEdit.API.Native.HeaderFooterType.Primary) Then
    ' Create a header.

word-processing-merge-documents-with-different-headers-and-footers/VB/DocumentMerger/Helpers/SectionsMerger.vb#L27

Private Shared Sub AppendHeader(ByVal sourceSection As Section, ByVal targetSection As Section, ByVal headerFooterType As HeaderFooterType)
    If Not sourceSection.HasHeader(headerFooterType) Then Return
    Dim source As SubDocument = sourceSection.BeginUpdateHeader(headerFooterType)

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

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

winforms-rich-edit-iterate-through-all-sub-documents/VB/SubDocumentIterator/SubDocumentHelper.vb#L23

Private Sub ProcessSection(ByVal section As Section, ByVal headerFooterType As HeaderFooterType, ByVal subDocumentProcessor As SubDocumentDelegate)
    If section.HasHeader(headerFooterType) Then
        Dim header As SubDocument = section.BeginUpdateHeader(headerFooterType)

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

' Check whether the document already has a header (the same header for all pages).
If Not firstSection.HasHeader(DevExpress.XtraRichEdit.API.Native.HeaderFooterType.Primary) Then
    Dim headerDocument As DevExpress.XtraRichEdit.API.Native.SubDocument = firstSection.BeginUpdateHeader()