Skip to main content

Section.BeginUpdateFooter() Method

Starts editing the primary footer for the current section.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

SubDocument BeginUpdateFooter()

Returns

Type Description
SubDocument

A SubDocument instance that is the footer being edited.

Remarks

Use the Section.BeginUpdateFooter - Section.EndUpdateFooter method pair to edit primary (the HeaderFooterType.Primary type) footer content. If the document has no footer as yet, this method creates a footer of the HeaderFooterType.Primary type and opens it for editing.

You can use the Section.HasFooter property to determine whether the document already has a footer which is the same for all pages (a footer of the HeaderFooterType.Primary type).

Example

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

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

See Also