Class RichTextEditorVideoSettings

A class used for configuring the video settings in the SfRichTextEditor.

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

Constructors

RichTextEditorVideoSettings()

Declaration
public RichTextEditorVideoSettings()

Properties

AllowedTypes

Gets or sets the allowed video extensions that populate the supported types of videos for browsing.

Declaration
[Parameter]
public List<string>? AllowedTypes { get; set; }
Property Value
Type Description
List<string>

A List<T> representing the types of videos that are allowed to be uploaded. The default values are .wmv, .mp4, .mov, .avi.
Remarks

The File Browser allows specified extension video files and restricts uploading of other types of files.

Examples

The following code example allows uploading only mp4 and avi video files.

@using Syncfusion.Blazor.RichTextEditor;
<SfRichTextEditor>
    <RichTextEditorToolbarSettings Items = "@Tools" />
    <RichTextEditorVideoSettings AllowedTypes="@TypeList" />
</SfRichTextEditor>
@code {
    List<string> TypeList = new List<string>() { ".mp4", ".avi" };
    private List<ToolbarItemModel> Tools = new List<ToolbarItemModel>()
    {
        new ToolbarItemModel() { Command = ToolbarCommand.Video }
    };
}

EnableResize

Gets or sets a value indicating whether the video element can be resized in the editor's content.

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

A bool value; true, if the video can be resized; otherwise, false. The default value is true.
Remarks

You can resize the video width to a maximum of MaxWidth and a minimum of MinWidth. Similarly, resize the video height to a maximum of MaxHeight and a minimum of MinHeight.

MaxFileSize

Gets or sets the maximum allowed file size of the video element to be uploaded in bytes.

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

A double value representing the maximum file size for the video element. The default value is 30000000.
Remarks

This property ensures that overly large files cannot be uploaded.

MaxHeight

Gets or sets the maximum height constraint of the video element.

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

A string value that represents the maximum height.
Remarks

The height value can be provided in pixels or percent (%) as a string type.

MaxWidth

Gets or sets the maximum width constraint of the video element.

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

A string value that represents the maximum width.
Remarks

The width value can be provided in pixels or percent (%) as a string type.

MinHeight

Gets or sets the minimum height constraint of the video element.

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

A string value that represents the minimum height.
Remarks

The minimum height value can be specified in pixels or percent (%) as a string type.

MinWidth

Gets or sets the minimum width constraint of the video element.

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

A string value that represents the minimum width.
Remarks

The minimum width value can be specified in pixels or percent (%) as a string type.

ResizeByPercent

Gets or sets whether the video resizing should enable percentage calculation.

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

A bool value; true, if the video can be resized based on percentage calculation; otherwise, false. The default value is true.

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

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

Implements