ChangeParagraphBackColorCommand Class

Changes the background color of the current paragraph.

Namespace: DevExpress.XtraRichEdit.Commands

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

Declaration

C#

public class ChangeParagraphBackColorCommand :
    ChangeParagraphFormattingCommandBase<Color>

VB.NET

Public Class ChangeParagraphBackColorCommand
    Inherits ChangeParagraphFormattingCommandBase(Of Color)

Remarks

The ChangeParagraphBackColorCommand command changes the shading (background color) for the entire paragraph where the current selection is located.

Use the ICommandUIState.EditValue to specify the color.

NOTE

The Paragraph.BackColor property is implemented for the same purpose.

The following code snippet demonstrates how the ICommandUIState.EditValue property should be used to execute value-based commands, such as ChangeFontBackColorCommand, ChangeFontColorCommand, ChangeFontNameCommand, ChangeFontSizeCommand, ChangeParagraphBackColorCommand.

C#

ChangeFontBackColorCommand cmd = new ChangeFontBackColorCommand(richEditControl1);
DevExpress.Utils.Commands.IValueBasedCommandUIState<Color> state = 
    cmd.CreateDefaultCommandUIState() 
    as DevExpress.Utils.Commands.IValueBasedCommandUIState<Color>;
state.Value = Color.Yellow;
cmd.ForceExecute(state);

VB.NET

Dim cmd As New ChangeFontBackColorCommand(richEditControl1)
Dim state As DevExpress.Utils.Commands.IValueBasedCommandUIState(Of Color) = _
 TryCast(cmd.CreateDefaultCommandUIState(),  _
 DevExpress.Utils.Commands.IValueBasedCommandUIState(Of Color))
state.Value = Color.Yellow
cmd.ForceExecute(state)

Inheritance

Object

Command

DevExpress.Utils.Commands.ControlCommand<IRichEditControl, RichEditCommandId, DevExpress.XtraRichEdit.Localization.XtraRichEditStringId>

DevExpress.XtraRichEdit.Commands.RichEditCommandBase<DevExpress.XtraRichEdit.Localization.XtraRichEditStringId>

RichEditCommand

DevExpress.XtraRichEdit.Commands.SelectionBasedCommandBase

SelectionBasedPropertyChangeCommandBase

DevExpress.XtraRichEdit.Commands.ChangeParagraphFormattingCommandBase<Color>

ChangeParagraphBackColorCommand