Skip to main content
Box

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

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.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

#Declaration

[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
)

#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.

See Also