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

RichTextBoxCommandBase

Class

Definition

Namespace:Telerik.WinForms.Documents.RichTextBoxCommands

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

public abstract class RichTextBoxCommandBase : ICommand

Inheritance: objectRichTextBoxCommandBase

Derived Classes: AcceptAllRevisionsCommandAcceptRevisionCommandCancelFormatPainterCommandChangeBibliographicStyleCommandChangeColorCommandBaseChangeFontFamilyCommandChangeFontSizeCommandChangeFormatPainterStateCommandChangeIntegratedWatermarkTypeCommandChangeLayoutModeCommandChangeListStyleCommandChangePageMarginsTypeCommandChangePageOrientationCommandChangePaperTypeCommandChangeParagraphFlowDirectionCommandChangeParagraphListLevelCommandChangeSectionColumnsCommandChangeSectionHeaderFooterMarginBaseChangeStyleNameCommandChangeTextAlignmentCommandChangeUnderlineDecorationCommandClearAllFormattingCommandClearFormattingCommandCommentCommandBaseContinueNumberingCommandCopyFormattingCommandDecrementFontSizeCommandDecrementParagraphLeftIndentCommandDeleteCodeBlockCommandDeleteCommandDrawingContextCommandBaseEditFooterCommandEditHeaderCommandExitHeaderFooterEditModeCommandFieldRangeStartBaseCommandBase<T>GoToNextEndnoteCommandGoToNextFootnoteCommandGoToNextRevisionCommandGoToPreviousEndnoteCommandGoToPreviousFootnoteCommandGoToPreviousRevisionCommandImageContextCommandBaseIncrementFontSizeCommandIncrementParagraphLeftIndentCommandInsertBreakCommandInsertColumnBreakCommandInsertDocumentFragmentCommandInsertEndnoteCommandInsertFieldCommandInsertFootnoteCommandInsertLineBreakCommandInsertLineNumberingCommandInsertNonBreakingSpaceCommandInsertPageBreakCommandInsertPictureCommandInsertSectionBreakCommandInsertStructuredDocumentTagCommandInsertTableCommandInsertTextCommandMailMergeDataSourceContextCommandBaseMergeTableCellsCommandMoveCaretCommandMoveSelectionCommandMultipleUndoCommandNewDocumentCommandOpenContextMenuOnNextSpellingErrorCommandOpenDocumentCommandPasteCommandPasteFormattingCommandPrintCommandPrintPreviewCommandRedoCommandRejectAllRevisionsCommandRejectRevisionCommandRemoveWatermarkCommandRestartNumberingCommandSaveCommandSelectAllCommandSelectionEnabledCommandShowAddNewBibliographicReferenceDialogCommandShowChangeEditingPermissionsDialogCommandShowCodeFormattingDialogCommandShowContentControlPropertiesDialogCommandShowDefineNewListStyleDialogCommandShowFindReplaceDialogCommandShowFontPropertiesDialogCommandShowInsertCaptionDialogCommandShowInsertCrossReferenceWindowCommandShowInsertDateTimeDialogCommandShowInsertHyperlinkDialogCommandShowInsertSymbolWindowCommandShowInsertTableDialogCommandShowInsertTableOfContentsDialogCommandShowLineNumberingDialogCommandShowManageBibliographicSourcesDialogCommandShowManageBookmarksDialogCommandShowManageStylesDialogCommandShowNotesDialogCommandShowParagraphPropertiesDialogCommandShowSectionColumnsDialogCommandShowSetNumberingValueDialogCommandShowSpellCheckingDialogCommandShowStyleFormattingPropertiesDialogCommandShowTabStopsPropertiesDialogCommandShowWatermarkSettingsDialogCommandSuppressLineNumberingForCurrentParagraphCommandTabBackwardCommandTabForwardCommandTableContextCommandBaseToggleCommandBaseUndoCommandUpdateAllFieldsCommand...

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)

public bool CanExecute(object parameter)

Parameters:parameterobjectReturns:

bool

Implements: ICommand.CanExecute(object)

CanExecuteOverride(object)

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()

public void Execute()

Execute(object, bool)

public void Execute(object parameter, bool focusCaret)

Parameters:parameterobjectfocusCaretbool

Execute(object)

public void Execute(object parameter)

Parameters:parameterobject

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()

protected Paragraph GetCurrentParagraphStyle()

Returns:

Paragraph

GetCurrentSectionStyle()

protected Section GetCurrentSectionStyle()

Returns:

Section

GetCurrentSpanStyle()

protected Span GetCurrentSpanStyle()

Returns:

Span

GetSelectedInlineOrSelectCurrent()

public Inline GetSelectedInlineOrSelectCurrent()

Returns:

Inline

OnCanExecuteChanged()

protected void OnCanExecuteChanged()

UpdateSectionStyle()

protected virtual void UpdateSectionStyle()

UpdateSpanStyle()

protected virtual void UpdateSpanStyle()

Events

CanExecuteChanged

EventHandler

public event EventHandler CanExecuteChanged

Implements: ICommand.CanExecuteChanged