Section.BeginUpdateHeader(HeaderFooterType) Method

Starts editing the document's header of the specified type.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

SubDocument BeginUpdateHeader(
    HeaderFooterType type
)

VB.NET

Function BeginUpdateHeader(
    type As HeaderFooterType
) As SubDocument

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 property to determine whether the document already has a header.