DocumentCapabilitiesOptions.HeadersFooters Property

Gets whether the headers and footers feature is allowed.

Namespace: DevExpress.XtraRichEdit

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

[DefaultValue(DocumentCapability.Default)]
public virtual DocumentCapability HeadersFooters { get; set; }

VB.NET

<DefaultValue(DocumentCapability.Default)>
Public Overridable Property HeadersFooters As DocumentCapability

Property Value

Type	Default	Description
DocumentCapability	Default	A DocumentCapability enumeration specifying the document’s capability to display, insert and modify headers and footers.

Available values:

Name	Description
Default	The value is determined by the current setting. The default value is automatically set if it is not explicitly specified.
Disabled	The feature is not allowed and the corresponding commands are shown disabled.
Enabled	The feature is available and the corresponding commands are shown enabled.
Hidden	The feature is not available and the corresponding commands are hidden.

Property Paths

You can access this nested property as listed below:

Object Type	Path to HeadersFooters
RichEditControlOptionsBase	.DocumentCapabilities .HeadersFooters

Remarks

The DocumentCapability.Default value for the HeadersFooters property is equal to DocumentCapability.Enabled, so that headers and footers can be displayed for a currently loaded document.

RichEditControl and RichEditDocumentServer removes headers and footers from an imported document if the HeadersFooters options is set to Disabled, and prevents users from creating new headers and footers in a document.