Class TelerikEditor

The class for the Telerik Editor component.

Inheritance
System.Object
BaseComponent
TelerikInputBase<System.String>
TelerikEditor
Inherited Members
Namespace: Telerik.Blazor.Components
Assembly: Telerik.Blazor.dll

Syntax

public class TelerikEditor : TelerikInputBase<string>, ILabelableInput, IDisposable, IEditorContainer

Constructors

TelerikEditor()

Declaration
public TelerikEditor()

Properties

Adaptive

Specify if the toolbar should adapt and automatically hide and show the overflowing items a popup. Default value is false.

Declaration
public bool Adaptive { get; set; }
Property Value
System.Boolean

DebounceDelay

Defines the debounce delay after which ValueChanged fires. Default value 100ms.

Declaration
public int DebounceDelay { get; set; }
Property Value
System.Int32

EditMode

Defines whether the editor should render iframe, or div for the content area.

Declaration
public EditorEditMode EditMode { get; set; }
Property Value
EditorEditMode

EditorCustomTools

Defines the container of custom tool renderings. EditorCustomTool.

Declaration
public RenderFragment EditorCustomTools { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment

EditorSettings

Defines the container of editor settings. EditorPasteSettings.

Declaration
public RenderFragment EditorSettings { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment

Height

Defines the height of the Editor. Default value 250px.

Declaration
public string Height { get; set; }
Property Value
System.String

Plugins

The name of the JS function declared in the global scope (window object) that will be used to provide custom ProseMirror plugins. The function accepts an arguments object with the following properties:

  1. getSchema - a function that returns the current schema object. Before the editor is initialized, the schema is the default schema. After the editor is initialized, the schema is the current schema.
  2. getView - a function that returns the currently used instance of EditorView object. Before the editor is initialized, the view (the result of the function) is null.
  3. ProseMirror - object that contains various ProseMirror classes and functions.
  4. getPlugins - function that accepts schema as an argument and returns the default Telerik Editor plugins. The function should return an array of ProseMirror plugins. Note: To ensure all the built-in functionalities of the Telerik Editor are working correctly, the result array should contain the default plugins which can be recieved by calling the getPlugins function.
Declaration
public string Plugins { get; set; }
Property Value
System.String

ReadOnly

The parameter is used to specify if the input field should be read-only. When set to true, the input becomes non-editable.

Declaration
public bool ReadOnly { get; set; }
Property Value
System.Boolean

Schema

The name of the JS function declared in the global scope (window object) that will be used to provide custom ProseMirror schema. The function accepts an arguments object with the following properties:

  1. getSchema - a function that returns the current schema object. Before the editor is initialized, the schema is the default schema. After the editor is initialized, the schema is the current schema.
  2. getView - a function that returns the currently used instance of EditorView object. Before the editor is initialized, the view (the result of the function) is null.
  3. ProseMirror - object that contains various ProseMirror classes and functions. The function should return an instance of the ProseMirror Schema class.
Declaration
public string Schema { get; set; }
Property Value
System.String

SpellCheck

Defines the spellcheck HTML attribute of the editable container in the component. Support and behavior depends on the user environment.

Declaration
public string SpellCheck { get; set; }
Property Value
System.String

Tools

Defines the default Tools collection. Default value Default.

Declaration
public List<IEditorTool> Tools { get; set; }
Property Value
System.Collections.Generic.List<IEditorTool>

Width

Defines the width of the Editor.

Declaration
public string Width { get; set; }
Property Value
System.String

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

ExecuteAsync(ToolCommandArgsBase)

Declaration
public Task ExecuteAsync(ToolCommandArgsBase args)
Parameters
ToolCommandArgsBase args

Returns
System.Threading.Tasks.Task

OnAfterRenderAsync(Boolean)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
System.Boolean firstRender

Returns
System.Threading.Tasks.Task

Overrides

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
System.Threading.Tasks.Task

Overrides
Telerik.Blazor.Components.Common.TelerikInputBase<System.String>.OnParametersSetAsync()