Class RichTextEditorMediaSettings

A class used for configuring the media settings in the Rich Text Editor. This class allows customization of how audio and video media are handled within the editor.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
RichTextEditorMediaSettings
RichTextEditorAudioSettings
RichTextEditorVideoSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.RichTextEditor
Assembly: Syncfusion.Blazor.dll
Syntax
public class RichTextEditorMediaSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

RichTextEditorMediaSettings()

Declaration
public RichTextEditorMediaSettings()

Properties

Height

Gets or sets the default height of the audio/video when inserted into the editor.

Declaration
[Parameter]
public string? Height { get; set; }
Property Value
Type Description
string

A string specifying the height value, which can be in pixels or percent (%). The default value is auto.
Remarks

Use this property to set the default height for media elements, enhancing visual consistency and layout control in the editor.

LayoutOption

Gets or sets whether the inserted audio/video is displayed as Inline or Break.

Declaration
[Parameter]
public DisplayLayoutOptions LayoutOption { get; set; }
Property Value
Type Description
DisplayLayoutOptions

One of the DisplayLayoutOptions enumeration. The default value is Inline.

Parent

Declaration
[CascadingParameter]
protected SfRichTextEditor? Parent { get; set; }
Property Value
Type
SfRichTextEditor

Path

Gets or sets the URL of the audio/video file save location.

Declaration
[Parameter]
public string? Path { get; set; }
Property Value
Type Description
string

A string representing the URL to save the audio/video file on the server. The default value is String.Empty.
Remarks

Specify a server path where media files are stored after being uploaded through the editor, facilitating media management and accessibility.

SaveFormat

Gets or sets whether the inserted audio/video is saved as a blob or base64 format.

Declaration
[Parameter]
public SaveFormat SaveFormat { get; set; }
Property Value
Type Description
SaveFormat

One of the SaveFormat enumeration. The default value is Blob.
Remarks

Choose the format in which media content is stored, impacting storage efficiency and processing time.

SaveUrl

Gets or sets the URL of the save action that will handle uploaded files and save them on the server.

Declaration
[Parameter]
public string? SaveUrl { get; set; }
Property Value
Type Description
string

A string representing the URL to save the files on the server. The default value is String.Empty.
Remarks

Define a server endpoint to process and store files uploaded through the editor's media interface, ensuring streamlined media access.

Width

Gets or sets the width of the audio/video when inserted into the editor.

Declaration
[Parameter]
public string? Width { get; set; }
Property Value
Type Description
string

A string specifying the width in pixels or percent (%). The default value is auto.
Remarks

Use this property to control the default display width of media elements for consistent and predictable media presentation in the editor.

isPropertyChanged

Declaration
protected bool isPropertyChanged { get; set; }
Property Value
Type
bool

Methods

Dispose(bool)

Dispose unmanaged resources in the Syncfusion Blazor component.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

Boolean value to dispose the object.
Overrides

OnAfterRenderAsync(bool)

Method invoked after each time the component has been rendered.

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
bool firstRender

Set to true if this is the first time OnAfterRender(Boolean) has been invoked.
Returns
Type Description
Task

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

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

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

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
Task

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

ShouldRender()

Declaration
protected override bool ShouldRender()
Returns
Type
bool
Overrides

Implements