Section.BeginUpdateFooter() Method

Starts editing the primary footer for the current section.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

SubDocument BeginUpdateFooter()

VB.NET

Function BeginUpdateFooter As SubDocument

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

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

HeaderAndFooter.vb

Dim firstSection As Section = document.Sections(0)
' Create an empty footer.
Dim newFooter As SubDocument = firstSection.BeginUpdateFooter()
firstSection.EndUpdateFooter(newFooter)
' Check whether the document already has a footer (the same footer for all pages).
If firstSection.HasFooter(HeaderFooterType.Primary) Then
    Dim footerDocument As SubDocument = firstSection.BeginUpdateFooter()
    document.ChangeActiveDocument(footerDocument)
    document.CaretPosition = footerDocument.CreatePosition(0)
    firstSection.EndUpdateFooter(footerDocument)
End If

HeaderAndFooter.cs

Section firstSection = document.Sections[0];
// Create an empty footer.
SubDocument newFooter = firstSection.BeginUpdateFooter();
firstSection.EndUpdateFooter(newFooter);
// Check whether the document already has a footer (the same footer for all pages).
if (firstSection.HasFooter(HeaderFooterType.Primary)) {
    SubDocument footerDocument = firstSection.BeginUpdateFooter();
    document.ChangeActiveDocument(footerDocument);
    document.CaretPosition = footerDocument.CreatePosition(0);
    firstSection.EndUpdateFooter(footerDocument);
}

Related GitHub Examples

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.

C#

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

// Create an empty footer.
SubDocument newFooter = firstSection.BeginUpdateFooter();
firstSection.EndUpdateFooter(newFooter);

aspxhtmleditor-how-to-embed-header-and-footer-to-exported-document-t135638/CS/WebApplication43/Default.aspx.cs#L39

void AddFooterToDocument(DevExpress.XtraRichEdit.API.Native.Document document, string htmlText) {
    SubDocument doc = document.Sections[0].BeginUpdateFooter();
    doc.AppendHtmlText(htmlText);

htmleditor-how-to-embed-header-and-footer-to-exported-document-t135639/CS/Project/Controllers/HomeController.cs#L66

void AddFooterToDocument(DevExpress.XtraRichEdit.API.Native.Document document, string htmlText) {
    SubDocument doc = document.Sections[0].BeginUpdateFooter();
    doc.AppendHtmlText(htmlText);

how-to-dynamically-generate-table-of-contents-by-adding-toc-field-with-different-nesting-l-t424524/CS/WindowsFormsApplication1/TOCHelpers.cs#L66

SubDocument myFooter = currentSection.BeginUpdateFooter();
DocumentRange range = myFooter.InsertText(myFooter.CreatePosition(0), " PAGE NUMBER ");

VB.NET

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

' Create an empty footer.
Dim newFooter As SubDocument = firstSection.BeginUpdateFooter()
firstSection.EndUpdateFooter(newFooter)

aspxhtmleditor-how-to-embed-header-and-footer-to-exported-document-t135638/VB/WebApplication43/Default.aspx.vb#L41

Private Sub AddFooterToDocument(ByVal document As DevExpress.XtraRichEdit.API.Native.Document, ByVal htmlText As String)
    Dim doc As SubDocument = document.Sections(0).BeginUpdateFooter()
    doc.AppendHtmlText(htmlText)

htmleditor-how-to-embed-header-and-footer-to-exported-document-t135639/VB/Project/Controllers/HomeController.vb#L68

Private Sub AddFooterToDocument(ByVal document As DevExpress.XtraRichEdit.API.Native.Document, ByVal htmlText As String)
    Dim doc As SubDocument = document.Sections(0).BeginUpdateFooter()
    doc.AppendHtmlText(htmlText)

how-to-dynamically-generate-table-of-contents-by-adding-toc-field-with-different-nesting-l-t424524/VB/WindowsFormsApplication1/TOCHelpers.vb#L70

Dim myFooter As SubDocument = currentSection.BeginUpdateFooter()
Dim range As DocumentRange = myFooter.InsertText(myFooter.CreatePosition(0), " PAGE NUMBER ")