Class CommandName

Defines the types used as command names.

Inheritance

System.Object

CommandName

Namespace: Syncfusion.Blazor.RichTextEditor

Assembly: Syncfusion.Blazor.dll

Syntax

public sealed class CommandName : Enum

Remarks

Commands dictate various text manipulation functionalities in the editor.

Fields

ApplyFormatPainter

Command to apply the previously copied formatting to the selected text.

Declaration

public const CommandName ApplyFormatPainter

Field Value

Type
CommandName

Audio

Defines the command name as Audio.

Declaration

public const CommandName Audio

Field Value

Type	Description
CommandName	Command for embedding audio files into the editor.

Remarks

Allows integration of audio clips in content creation.

BackgroundColor

Defines the command name as BackColor.

Declaration

public const CommandName BackgroundColor

Field Value

Type	Description
CommandName	Background color command, changing text background.

Remarks

Alters the background color of selected text to improve contrast or focus.

Blockquote

Defines the command name as Blockquote.

Declaration

public const CommandName Blockquote

Field Value

Type	Description
CommandName	Blockquote command, styling text as a quotation.

Remarks

Formats the selected text or paragraph as a blockquote element.

Bold

Defines the command name as Bold.

Declaration

public const CommandName Bold

Field Value

Type	Description
CommandName	Bold text command, applying bold formatting.

Remarks

Emphasizes selected text by making it bold.

BulletFormatList

Specifies the command used to create bullet formatted lists.

Declaration

public const CommandName BulletFormatList

Field Value

Type	Description
CommandName	Represents the `BulletFormatList` command, which creates bullet lists according to the style specified in the ExecuteCommandAsync(CommandName, String, ExecuteCommandOption) method argument.

Remarks

This command converts selected text into a bullet list with a format defined by the argument provided to the ExecuteCommandAsync(CommandName, String, ExecuteCommandOption) method.

Examples

///

await richTextEditorObj.ExecuteCommandAsync(CommandName.BulletFormatList, "decimal", executeCommandOption);

CopyFormatPainter

Command to copy formatting from the selected text.

Declaration

public const CommandName CopyFormatPainter

Field Value

Type
CommandName

CreateLink

Defines the command name as CreateLink.

Declaration

public const CommandName CreateLink

Field Value

Type	Description
CommandName	Link creation command, adding hyperlinks.

Remarks

Adds a hyperlink to the selected text or object, making it a clickable element.

EditImage

Defines the command name as EditImage.

Declaration

public const CommandName EditImage

Field Value

Type	Description
CommandName	Image edit command, modifying inserted images.

Remarks

Provides options to edit attributes and properties of inserted images.

EditLink

Defines the command name as EditLink.

Declaration

public const CommandName EditLink

Field Value

Type	Description
CommandName	Link edit command, modifying hyperlink details.

Remarks

Allows modification of URL and display text of an existing hyperlink.

ExportPdf

Defines the command name as ExportToPdf.

Declaration

public const CommandName ExportPdf

Field Value

Type	Description
CommandName	PDF export command, saving content in a PDF format.

Remarks

Exports the current content in the editor as a PDF document for distribution or preservation.

ExportWord

Defines the command name as ExportToWord.

Declaration

public const CommandName ExportWord

Field Value

Type	Description
CommandName	Export command to convert content into a Word document.

Remarks

Allows users to export the editor's content into a Word-compatible format.

FontColor

Defines the command name as FontColor.

Declaration

public const CommandName FontColor

Field Value

Type	Description
CommandName	Font color command, altering text color.

Remarks

Allows changing the color of selected text to enhance readability or emphasis.

FontName

Defines the command name as FontName.

Declaration

public const CommandName FontName

Field Value

Type	Description
CommandName	Command to change the font typeface.

Remarks

Selects a different font for the highlighted text.

Type	Description
CommandName	Font size command, adjusting text size.

FormatBlock

Defines the command name as FormatBlock.

Declaration

public const CommandName FormatBlock

Field Value

Type	Description
CommandName	Block formatting command, altering block elements.

Remarks

Applies a block-level formatting style to the selected text or paragraph.

Heading

Defines the command name as Heading.

Declaration

public const CommandName Heading

Field Value

Type	Description
CommandName	Heading command, applying heading styles.

Remarks

Formats selected text as a heading level, depending on the style applied.

ImportWord

Defines the command name as ImportWord.

Declaration

public const CommandName ImportWord

Field Value

Type	Description
CommandName	Word document import command, bringing content into the editor.

Remarks

Facilitates importing content from Microsoft Word documents into the editor.

Indent

Defines the command name as Indent.

Declaration

public const CommandName Indent

Field Value

Type	Description
CommandName	Indentation command, increasing text indent.

Remarks

Increases the indent level of the selected text or block.

InsertBrOnReturn

Defines the command name as InsertBrOnReturn.

Declaration

public const CommandName InsertBrOnReturn

Field Value

Type	Description
CommandName	Break insertion command upon pressing Enter.

Remarks

Inserts a <br> tag instead of creating a new paragraph when Enter is pressed.

InsertCode

Defines the command name as InsertCode.

Declaration

public const CommandName InsertCode

Field Value

Type	Description
CommandName	Code insertion command, embedding code blocks.

Remarks

Adds a preformatted block for code snippets within the text.

InsertCodeBlock

Defines the command name as InsertCodeBlock.

Declaration

public const CommandName InsertCodeBlock

Field Value

Type	Description
CommandName	Inserts a code block into the editor.

Remarks

Adds a formatted code block element to the editor content, typically used for displaying preformatted code.

InsertHorizontalRule

Defines the command name as InsertHorizontalRule.

Declaration

public const CommandName InsertHorizontalRule

Field Value

Type	Description
CommandName	Horizontal rule command, adding a line across the editor.

Remarks

Inserts a horizontal line separator into the document.

InsertHTML

Defines the command name as InsertHTML.

Declaration

public const CommandName InsertHTML

Field Value

Type	Description
CommandName	HTML insertion command, adding HTML content directly.

Remarks

Allows inserting of raw HTML code into the editor content.

InsertImage

Defines the command name as InsertImage.

Declaration

public const CommandName InsertImage

Field Value

Type	Description
CommandName	Image insertion command, embedding images into content.

Remarks

Inserts an image at the selected cursor position within the editor.

InsertOrderedList

Defines the command name as InsertOrderedList.

Declaration

public const CommandName InsertOrderedList

Field Value

Type	Description
CommandName	Ordered list command, creating a numbered list.

Remarks

Converts selected text into a numbered list format.

InsertParagraph

Defines the command name as InsertParagraph.

Declaration

public const CommandName InsertParagraph

Field Value

Type	Description
CommandName	Command to create a new paragraph block.

Remarks

Inserts a paragraph block at the cursor's location.

InsertTable

Defines the command name as InsertTable.

Declaration

public const CommandName InsertTable

Field Value

Type	Description
CommandName	Table insertion command, creating a grid for data.

Remarks

Inserts a table structure into the editor for organizing content in rows and columns.

InsertText

Defines the command name as InsertText.

Declaration

public const CommandName InsertText

Field Value

Type	Description
CommandName	Text insertion command, adding plain text at the cursor.

Remarks

Directly inserts plain text into the editor at the current cursor location.

InsertUnorderedList

Defines the command name as InsertUnorderedList.

Declaration

public const CommandName InsertUnorderedList

Field Value

Type	Description
CommandName	Unordered list command, creating a bullet list.

Remarks

Transforms selected text into a list with bullet points.

Italic

Defines the command name as Italic.

Declaration

public const CommandName Italic

Field Value

Type	Description
CommandName	Italic text command, applying italic formatting.

Remarks

Highlights selected text with an italic style.

JustifyCenter

Defines the command name as JustifyCenter.

Declaration

public const CommandName JustifyCenter

Field Value

Type	Description
CommandName	Centering command, aligning text to the center.

Remarks

Centers text alignment in the selected area.

JustifyFull

Defines the command name as JustifyFull.

Declaration

public const CommandName JustifyFull

Field Value

Type	Description
CommandName	Full justification command, equalizing text on both sides.

Remarks

Spreads text evenly across the entire width of its container.

JustifyLeft

Defines the command name as JustifyLeft.

Declaration

public const CommandName JustifyLeft

Field Value

Type	Description
CommandName	Left justification command, aligning text to the left.

Remarks

Aligns text to the left margin of the content area.

JustifyRight

Defines the command name as JustifyRight.

Declaration

public const CommandName JustifyRight

Field Value

Type	Description
CommandName	Right justification command, aligning text to the right.

Remarks

Aligns text to the right margin of the content area.

Lowercase

Defines the command name as Lowercase.

Declaration

public const CommandName Lowercase

Field Value

Type	Description
CommandName	Lowercase command, converting text to lowercase.

Remarks

Converts the selected text characters into lowercase format.

NumberFormatList

Specifies the command used to create number formatted lists.

Declaration

public const CommandName NumberFormatList

Field Value

Type	Description
CommandName	Represents the `NumberFormatList` command, which creates ordered lists according to the style specified in the ExecuteCommandAsync(CommandName, String, ExecuteCommandOption) method argument.

Remarks

This command converts selected text into an ordered list with a number format specified by the argument provided to the ExecuteCommandAsync(CommandName, String, ExecuteCommandOption) method.

Examples

///

await richTextEditorObj.ExecuteCommandAsync(CommandName.NumberFormatList, "decimal", executeCommandOption);

Outdent

Defines the command name as Outdent.

Declaration

public const CommandName Outdent

Field Value

Type	Description
CommandName	Outdent command, reducing text indent.

Remarks

Decreases the indent level of the selected text or block.

Redo

Defines the command name as Redo.

Declaration

public const CommandName Redo

Field Value

Type	Description
CommandName	Redo command, restoring the last undone action.

Remarks

Reapplies the most recent action that was undone.

RemoveFormat

Defines the command name as RemoveFormat.

Declaration

public const CommandName RemoveFormat

Field Value

Type	Description
CommandName	Remove format command, clearing all formatting.

Remarks

Strips all formatting from the selected text, reverting it to plain text.

StrikeThrough

Defines the command name as StrikeThrough.

Declaration

public const CommandName StrikeThrough

Field Value

Type	Description
CommandName	Strike-through command applies a line through text.

Remarks

Useful for indicating text that has been deleted or is no longer relevant.

Subscript

Defines the command name as Subscript.

Declaration

public const CommandName Subscript

Field Value

Type	Description
CommandName	Subscript command, lowering text below baseline.

Remarks

Typically used for chemical formulas or base notations.

Superscript

Defines the command name as Superscript.

Declaration

public const CommandName Superscript

Field Value

Type	Description
CommandName	Superscript command, raising text above baseline.

Remarks

Ideal for mathematical expressions like exponents.

Underline

Defines the command name as Underline.

Declaration

public const CommandName Underline

Field Value

Type	Description
CommandName	Underline command, underlining selected text.

Remarks

Adds a line under selected text, emphasizing it.

Undo

Defines the command name as Undo.

Declaration

public const CommandName Undo

Field Value

Type	Description
CommandName	Undo command, reversing the last action.

Remarks

Reverts the most recent change made to the content.

Uppercase

Defines the command name as Uppercase.

Declaration

public const CommandName Uppercase

Field Value

Type	Description
CommandName	Uppercase command, converting text to uppercase.

Remarks

Converts the selected text characters into uppercase format.

Video

Defines the command name as Video.

Declaration

public const CommandName Video

Field Value

Type	Description
CommandName	Command for embedding video files within the editor.

Remarks

Supports adding visual media for rich content experiences.

Class CommandName

Inheritance

Namespace: Syncfusion.Blazor.RichTextEditor

Assembly: Syncfusion.Blazor.dll

Syntax

Remarks

Fields

ApplyFormatPainter

Declaration

Field Value

Audio

Declaration

Field Value

Remarks

BackgroundColor

Declaration

Field Value

Remarks

Blockquote

Declaration

Field Value

Remarks

Bold

Declaration

Field Value

Remarks

BulletFormatList

Declaration

Field Value

Remarks

Examples

CopyFormatPainter

Declaration

Field Value

CreateLink

Declaration

Field Value

Remarks

EditImage

Declaration

Field Value

Remarks

EditLink

Declaration

Field Value

Remarks

ExportPdf

Declaration

Field Value

Remarks

ExportWord

Declaration

Field Value

Remarks

FontColor

Declaration

Field Value

Remarks

FontName

Declaration

Field Value

Remarks

FontSize

Declaration

Field Value

Remarks

FormatBlock

Declaration

Field Value

Remarks

Heading

Declaration

Field Value

Remarks

ImportWord

Declaration

Field Value

Remarks

Indent

Declaration