Table of Contents

Class QuillJSTextEditor

Namespace
Oqtane.Modules.Controls
Assembly
Oqtane.Client.dll
public class QuillJSTextEditor : ModuleControlBase, IModuleControl, ITextEditor
Inheritance
object
ComponentBase
QuillJSTextEditor
Implements
Inherited Members

Properties

AllowFileManagement

[Parameter]
public bool? AllowFileManagement { get; set; }

Property Value

bool?

AllowRawHtml

[Parameter]
public bool? AllowRawHtml { get; set; }

Property Value

bool?

AllowRichText

[Parameter]
public bool? AllowRichText { get; set; }

Property Value

bool?

DebugLevel

[Parameter]
public string DebugLevel { get; set; }

Property Value

string

Name

public string Name { get; }

Property Value

string

Placeholder

[Parameter]
public string Placeholder { get; set; }

Property Value

string

ReadOnly

[Parameter]
public bool ReadOnly { get; set; }

Property Value

bool

Resources

Identifies all resources in a module

public override List<Resource> Resources { get; set; }

Property Value

List<Resource>

Theme

[Parameter]
public string Theme { get; set; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

Renders the component to the supplied Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder.

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

CloseRawFileManager()

public void CloseRawFileManager()

CloseRichFileManager()

public void CloseRichFileManager()

GetContent()

get content from the editor.

public Task<string> GetContent()

Returns

Task<string>

GetHtml()

public Task<string> GetHtml()

Returns

Task<string>

Initialize(string)

initializes the editor with the initialize content.

public void Initialize(string content)

Parameters

content string

the initialize content.

InsertRawImage()

public Task InsertRawImage()

Returns

Task

InsertRichImage()

public Task InsertRichImage()

Returns

Task

OnAfterRenderAsync(bool)

Method invoked after each time the component has been rendered interactively and the UI has finished updating (for example, after elements have been added to the browser DOM). Any Microsoft.AspNetCore.Components.ElementReference fields will be populated by the time this runs.

This method is not invoked during prerendering or server-side rendering, because those processes are not attached to any live browser DOM and are already complete before the DOM is updated.

Note that the component does not automatically re-render after the completion of any returned System.Threading.Tasks.Task, because that would cause an infinite render loop.

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender bool

Set to true if this is the first time Microsoft.AspNetCore.Components.ComponentBase.OnAfterRender(bool) has been invoked on this component instance; otherwise false.

Returns

Task

A System.Threading.Tasks.Task representing any asynchronous operation.

Remarks

The Microsoft.AspNetCore.Components.ComponentBase.OnAfterRender(bool) and Microsoft.AspNetCore.Components.ComponentBase.OnAfterRenderAsync(bool) lifecycle methods are useful for performing interop, or interacting with values received from @ref. Use the firstRender parameter to ensure that initialization work is only performed once.

OnInitialized()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree.

protected override void OnInitialized()

OnParametersSet()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

protected override void OnParametersSet()