DocumentCapabilitiesOptions.CharacterFormatting Property

Gets or sets the character formatting features availability.

Namespace: DevExpress.XtraRichEdit

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

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
DocumentCapability	**Default**	A DocumentCapability enumeration specifying the document’s capability to change character 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 CharacterFormatting
WinForms Controls	SnapControlOptions	.DocumentCapabilities.CharacterFormatting
	RichEditControlOptions	.DocumentCapabilities.CharacterFormatting
WPF Controls	RichEditControlOptions	.DocumentCapabilities.CharacterFormatting
Office File API	RichEditControlOptionsBase	.DocumentCapabilities.CharacterFormatting
ASP.NET Web Forms Controls	ASPxRichEditSettings	.DocumentCapabilities.CharacterFormatting

Remarks

This property affects behavior of the following commands:

• commands derived from the DevExpress.XtraRichEdit.Commands.ChangeCharacterFormattingCommandBase:

  • ChangeFontBackColorCommand
  • ChangeFontColorCommand
  • ChangeFontNameCommand
  • ChangeFontSizeCommand
  • DecreaseFontSizeCommand
  • DecrementFontSizeCommand
  • IncreaseFontSizeCommand
  • IncrementFontSizeCommand
  • ShowFontFormCommand
  • ToggleFontBoldCommand
  • ToggleFontDoubleStrikeoutCommand
  • ToggleFontDoubleUnderlineCommand
  • ToggleFontItalicCommand
  • ToggleFontStrikeoutCommand
  • ToggleFontSubscriptCommand
  • ToggleFontSuperscriptCommand
  • ToggleFontUnderlineCommand
  • ToggleHiddenTextCommand
• ClearFormattingCommand

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