Section.HasFooter(HeaderFooterType) Method

Gets whether a section has a footer 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 HasFooter(
    HeaderFooterType type
)

VB.NET

Function HasFooter(
    type As HeaderFooterType
) As Boolean

Parameters

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

Returns

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

Remarks

When a new footer is created using the Section.BeginUpdateFooter method without arguments, it is the footer 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 HasFooter method to check for the HeaderFooterType.Primary footer type.

Related GitHub Examples

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

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

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

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

}
if (section.HasFooter(headerFooterType))
{

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

// Check whether the document already has a footer (the same footer for all pages).
if (firstSection.HasFooter(HeaderFooterType.Primary)) {
    SubDocument footerDocument = firstSection.BeginUpdateFooter();

snap-convert-snx-to-repx/CS/SnxToRepx/Converter/SnapReportConverter.cs#L174

//Check if the section has a footer of the Primary type
if (section.HasFooter(HeaderFooterType.Primary))
{

VB.NET

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

Private Shared Sub AppendFooter(ByVal sourceSection As Section, ByVal targetSection As Section, ByVal headerFooterType As HeaderFooterType)
    If Not sourceSection.HasFooter(headerFooterType) Then Return
    Dim source As SubDocument = sourceSection.BeginUpdateFooter(headerFooterType)

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

If section.HasFooter(headerFooterType) Then
    Dim footer As SubDocument = section.BeginUpdateFooter(headerFooterType)

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

' Check whether the document already has a footer (the same footer for all pages).
If firstSection.HasFooter(DevExpress.XtraRichEdit.API.Native.HeaderFooterType.Primary) Then
    Dim footerDocument As DevExpress.XtraRichEdit.API.Native.SubDocument = firstSection.BeginUpdateFooter()

snap-convert-snx-to-repx/VB/SnxToRepx/Converter/SnapReportConverter.vb#L149

'Check if the section has a footer of the Primary type
If section.HasFooter(HeaderFooterType.Primary) Then
    'If so, copy its content to a separate SnapDocumentServer and process its content