New to Telerik UI for WPF? Start a free 30-day trial

RichTextBoxCommandBase

Class

Represents the base class for commands that can be executed within a RichTextBox.

Definition

Namespace:Telerik.Windows.Documents.RichTextBoxCommands

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

public abstract class RichTextBoxCommandBase : ICommand

Inheritance: objectRichTextBoxCommandBase

Derived Classes: AcceptAllRevisionsCommandAcceptRevisionCommandAddShapeTextBoxCommandCancelFormatPainterCommandChangeBibliographicStyleCommandChangeColorCommandBaseChangeFontFamilyCommandChangeFontSizeCommandChangeFormatPainterStateCommandChangeIntegratedWatermarkTypeCommandChangeLayoutModeCommandChangeListStyleCommandChangePageMarginsTypeCommandChangePageOrientationCommandChangePaperTypeCommandChangeParagraphFlowDirectionCommandChangeParagraphListLevelCommandChangeSectionColumnsCommandChangeSectionHeaderFooterMarginBaseChangeStyleNameCommandChangeTextAlignmentCommandChangeUnderlineDecorationCommandClearAllFormattingCommandClearFormattingCommandCommentCommandBaseContinueNumberingCommandCopyFormattingCommandDecrementFontSizeCommandDecrementParagraphLeftIndentCommandDeleteCodeBlockCommandDeleteCommandDrawingContextCommandBaseEditFooterCommandEditHeaderCommandEditShapeTextBoxCommandExitHeaderFooterEditModeCommandFieldRangeStartBaseCommandBase<T>GoToNextEndnoteCommandGoToNextFootnoteCommandGoToNextRevisionCommandGoToPreviousEndnoteCommandGoToPreviousFootnoteCommandGoToPreviousRevisionCommandImageContextCommandBaseIncrementFontSizeCommandIncrementParagraphLeftIndentCommandInsertBreakCommandInsertColumnBreakCommandInsertDocumentFragmentCommandInsertEndnoteCommandInsertFieldCommandInsertFootnoteCommandInsertLineBreakCommandInsertLineNumberingCommandInsertNonBreakingSpaceCommandInsertPageBreakCommandInsertPictureCommandInsertSectionBreakCommandInsertStructuredDocumentTagCommandInsertTableCommandInsertTextCommandMailMergeDataSourceContextCommandBaseMergeTableCellsCommandMoveCaretCommandMoveSelectionCommandMultipleUndoCommandNewDocumentCommandOpenContextMenuOnNextSpellingErrorCommandOpenDocumentCommandPasteCommandPasteFormattingCommandPrintCommandPrintPreviewCommandRedoCommandRejectAllRevisionsCommandRejectRevisionCommandRemoveWatermarkCommandRestartNumberingCommandSaveCommandSelectAllCommandSelectionEnabledCommandShapeContextCommandBaseShowAddNewBibliographicReferenceDialogCommandShowChangeEditingPermissionsDialogCommandShowCodeFormattingDialogCommandShowContentControlPropertiesDialogCommandShowDefineNewListStyleDialogCommandShowFindReplaceDialogCommandShowFontPropertiesDialogCommandShowInsertCaptionDialogCommandShowInsertCrossReferenceWindowCommandShowInsertDateTimeDialogCommandShowInsertHyperlinkDialogCommandShowInsertSymbolWindowCommandShowInsertTableDialogCommandShowInsertTableOfContentsDialogCommandShowLineNumberingDialogCommandShowManageBibliographicSourcesDialogCommandShowManageBookmarksDialogCommandShowManageStylesDialogCommandShowNotesDialogCommandShowParagraphPropertiesDialogCommandShowSectionColumnsDialogCommandShowSetNumberingValueDialogCommandShowSpellCheckingDialogCommandShowStyleFormattingPropertiesDialogCommandShowTabStopsPropertiesDialogCommandShowTaskPaneCommandShowWatermarkSettingsDialogCommandSuppressLineNumberingForCurrentParagraphCommandTabBackwardCommandTabForwardCommandTableContextCommandBaseToggleCommandBaseToggleInsertShapeToolCommandUndoCommandUpdateAllFieldsCommand...

Implements: ICommand

Constructors

RichTextBoxCommandBase(RadRichTextBox)

public RichTextBoxCommandBase(RadRichTextBox editor)

Parameters:editorRadRichTextBox

Properties

AssociatedRichTextBox

RadRichTextBox

Gets the associated rich text box.

public RadRichTextBox AssociatedRichTextBox { get; }

Property Value:

The associated rich text box.

CanExecuteBehaviorInProtectedDocument

Gets a value indicating whether the behavior of the command can be executed in a protected document.

protected virtual CanExecuteBehaviorInProtectedDocument CanExecuteBehaviorInProtectedDocument { get; }

CanExecuteInReadOnlyMode

bool

Gets a value indicating whether this command can be executed when RadRichTextBox is read-only. The default implementation returns false.

protected virtual bool CanExecuteInReadOnlyMode { get; }

Property Value:

true if this command preserves document's content; otherwise, false.

CanExecuteInReadOnlyRange

bool

Gets a value indicating whether this command can be executed when editing context is read-only. The default implementation returns false.

protected virtual bool CanExecuteInReadOnlyRange { get; }

Enabled

bool

Gets or sets a value indicating whether the command is enabled.

public bool Enabled { get; set; }

IsDeletingCommand

bool

protected virtual bool IsDeletingCommand { get; }

ShouldFocusCaretAfterExecute

bool

protected virtual bool ShouldFocusCaretAfterExecute { get; }

SupportedTargets

CommandTargets

Gets the supported CommandTargets for the command.

protected virtual CommandTargets SupportedTargets { get; }

Methods

CanExecute(object)

bool

Determines whether the command can be executed with the specified parameter.

public bool CanExecute(object parameter)

Parameters:parameterobject

The parameter to evaluate for the command execution.

Returns:

bool

True if the command can be executed; otherwise, false.

Implements: ICommand.CanExecute(object)

CanExecuteOverride(object)

bool

Performs a check whether the command can be executed specific to the command.

protected virtual bool CanExecuteOverride(object parameter)

Parameters:parameterobject

The command parameter.

Returns:

bool

Execute()

Executes the command, performing the associated action on the RichTextBox.

public void Execute()

Execute(object, bool)

Executes the command with the specified parameter and an option to suppress events.

public void Execute(object parameter, bool focusCaret)

Parameters:parameterobject

The parameter to be used during the command execution.

focusCaretbool

A boolean value indicating whether to suppress events during execution.

Execute(object)

Executes the command with the specified parameter.

public void Execute(object parameter)

Parameters:parameterobject

The parameter to execute the command with.

Implements: ICommand.Execute(object)

ExecuteOverride(object)

Performs the execute action specific to the command.

protected abstract void ExecuteOverride(object parameter)

Parameters:parameterobject

The command parameter.

GetCurrentParagraphStyle()

Paragraph

protected Paragraph GetCurrentParagraphStyle()

Returns:

Paragraph

GetCurrentSectionStyle()

Section

protected Section GetCurrentSectionStyle()

Returns:

Section

GetCurrentSpanStyle()

Span

protected Span GetCurrentSpanStyle()

Returns:

Span

GetSelectedInlineOrSelectCurrent()

Inline

Retrieves the currently selected inline element in the RichTextBox. If there is no selection, it selects the current inline element.

public Inline GetSelectedInlineOrSelectCurrent()

Returns:

Inline

The selected inline element, or the current inline element if no selection is made.

OnCanExecuteChanged()

protected void OnCanExecuteChanged()

UpdateSectionStyle()

protected virtual void UpdateSectionStyle()

UpdateSpanStyle()

protected virtual void UpdateSpanStyle()

Events

CanExecuteChanged

EventHandler

public event EventHandler CanExecuteChanged

Implements: ICommand.CanExecuteChanged