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
Namespace: Syncfusion.Blazor.RichTextEditor
Assembly: Syncfusion.Blazor.dll
Syntax
public class RichTextEditorMediaSettings : OwningComponentBaseConstructors
RichTextEditorMediaSettings()
Declaration
public RichTextEditorMediaSettings()Properties
Height
Gets or sets the default height of the audio/video when inserted into the editor.
Declaration
public string Height { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | A string specifying the height value, which can be in pixels or percent (%). The default value is |
Remarks
Use this property to set the default height for media elements, enhancing visual consistency and layout control in the editor.
isPropertyChanged
Declaration
protected bool isPropertyChanged { get; set; }Property Value
| Type |
|---|
| System.Boolean |
LayoutOption
Gets or sets whether the inserted audio/video is displayed as Inline or Break.
Declaration
public DisplayLayoutOptions LayoutOption { get; set; }Property Value
| Type | Description |
|---|---|
| DisplayLayoutOptions | One of the DisplayLayoutOptions enumeration. The default value is Inline. |
Parent
Declaration
protected SfRichTextEditor Parent { get; set; }Property Value
| Type |
|---|
| SfRichTextEditor |
Path
Gets or sets the URL of the audio/video file save location.
Declaration
public string Path { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | A string representing the URL to save the audio/video file on the server. The default value is |
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
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
public string SaveUrl { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | A string representing the URL to save the files on the server. The default value is |
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
public string Width { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | A string specifying the width in pixels or percent (%). The default value is |
Remarks
Use this property to control the default display width of media elements for consistent and predictable media presentation in the editor.
Methods
Dispose(Boolean)
Dispose unmanaged resources in the Syncfusion Blazor component.
Declaration
protected override void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing | Boolean value to dispose the object. |
OnAfterRenderAsync(Boolean)
Method invoked after each time the component has been rendered.
Declaration
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | firstRender | Set to true if this is the first time OnAfterRender(Boolean) has been invoked. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing any asynchronous operation. |
OnInitializedAsync()
Method invoked when the component is ready to start.
Declaration
protected override Task OnInitializedAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing any asynchronous operation. |
OnParametersSetAsync()
Method invoked when the component has received parameters from its parent.
Declaration
protected override Task OnParametersSetAsync()Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | A System.Threading.Tasks.Task representing any asynchronous operation. |
ShouldRender()
Declaration
protected override bool ShouldRender()Returns
| Type |
|---|
| System.Boolean |