Section.BeginUpdateHeader(HeaderFooterType) Method
Starts editing the document’s header of the specified type.
Namespace: DevExpress.XtraRichEdit.API.Native
Assembly: DevExpress.RichEdit.v19.1.Core.dll
Declaration
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
The following code snippet opens the first section’s header for editing. The header type is HeaderFooterType.First, so it is displayed for the first page only if the corresponding mode is enabled (use the Section.DifferentFirstPage property). Then, the text string and a PAGE field are inserted and the Section.EndUpdateHeader method is called to finalize the modification.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the BeginUpdateHeader(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.