LayoutHeader.BeginUpdate(HeaderFooterType) Method

OBSOLETE

This method has become obsolete. Use the 'DevExpress.XtraRichEdit.API.Layout.DocumentLayout.BeginUpdateDocument(RangedLayoutElement element)' where 'element' is LayoutHeader instance.

Provides access to a SubDocument for the Rich Text Editor document’s header which relates to the current layout object.

Namespace: DevExpress.XtraRichEdit.API.Layout

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

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

Declaration

C#

[Obsolete("This method has become obsolete. Use the 'DevExpress.XtraRichEdit.API.Layout.DocumentLayout.BeginUpdateDocument(RangedLayoutElement element)' where 'element' is LayoutHeader instance.", true)]
public override SubDocument BeginUpdate(
    HeaderFooterType type
)

VB.NET

<Obsolete("This method has become obsolete. Use the 'DevExpress.XtraRichEdit.API.Layout.DocumentLayout.BeginUpdateDocument(RangedLayoutElement element)' where 'element' is LayoutHeader instance.", True)>
Public Overrides Function BeginUpdate(
    type As HeaderFooterType
) As SubDocument

Parameters

Name	Type	Description
type	HeaderFooterType	A HeaderFooterType enumeration value, that is the type of the header for which a content is obtained.

Returns

Type	Description
SubDocument	A SubDocument object which is the header content.

Remarks

The BeginUpdate method is similar to the Section.BeginUpdateHeader method.