DocumentCapabilitiesOptions.ParagraphFormatting Property

Gets or sets the paragraph formatting features availability.

Namespace: DevExpress.XtraRichEdit

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

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
DocumentCapability	**Default**	A DocumentCapability enumeration, specifying the document’s capability to change paragraph formatting.

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:

Library	Object Type	Path to ParagraphFormatting
WinForms Controls	SnapControlOptions	.DocumentCapabilities.ParagraphFormatting
	RichEditControlOptions	.DocumentCapabilities.ParagraphFormatting
WPF Controls	RichEditControlOptions	.DocumentCapabilities.ParagraphFormatting
Office File API	RichEditControlOptionsBase	.DocumentCapabilities.ParagraphFormatting
ASP.NET Web Forms Controls	ASPxRichEditSettings	.DocumentCapabilities.ParagraphFormatting

Remarks

This property affects the behavior of the following commands:

• Commands derived from the DevExpress.XtraRichEdit.Commands.ChangeParagraphFormattingCommandBase:

  • ShowParagraphFormCommand
  • ToggleParagraphAlignmentCenterCommand
  • ToggleParagraphAlignmentJustifyCommand
  • ToggleParagraphAlignmentLeftCommand
  • ToggleParagraphAlignmentRightCommand
  • ToggleParagraphAlignmentArabicJustifyCommand
  • ToggleParagraphAlignmentArabicJustifyGroupCommand
  • ToggleParagraphAlignmentJustifyCommand
  • ToggleParagraphAlignmentJustifyHighCommand
  • ToggleParagraphAlignmentJustifyLowCommand
  • ToggleParagraphAlignmentJustifyMediumCommand
  • ToggleParagraphAlignmentDistributeCommand
  • ToggleParagraphAlignmentThaiDistributeCommand
  • SetDoubleParagraphSpacingCommand
  • SetSesquialteralParagraphSpacingCommand
  • SetSingleParagraphSpacingCommand
  • DecrementIndentCommandBase
  • IncrementIndentCommandBase

The DocumentCapability.Default value for the ParagraphFormatting property is equal to DocumentCapability.Enabled, so that the paragraph formatting is available for a currently loaded document.

Use the RichEditBehaviorOptions.RightToLeftTextDirection option to manage the availability of the ToggleParagraphRightToLeftCommand and ToggleParagraphLeftToRightCommand commands.

The RichEditBehaviorOptions.EastAsianTextAlignment property has a priority over the ParagraphFormatting option.