Class ColorItemBase

A class used for configuring the font or background color properties in the SfRichTextEditor.

Inheritance

System.Object

ColorItemBase

RichTextEditorBackgroundColor

RichTextEditorFontColor

Namespace: Syncfusion.Blazor.RichTextEditor

Assembly: Syncfusion.Blazor.dll

Syntax

public class ColorItemBase : OwningComponentBase

Constructors

ColorItemBase()

Declaration

public ColorItemBase()

Properties

ColorCode

Gets or sets the color code in the color picker palette for content background and font color.

Declaration

public Dictionary<string, string[]> ColorCode { get; set; }

Property Value

Type
System.Collections.Generic.Dictionary<System.String, System.String[]>

Remarks

Passing string.Empty as a value in the array will display it as a transparant color in the palette.

Columns

Gets or sets the number of columns that is displayed on a row in the color picker palette.

Declaration

public int Columns { get; set; }

Property Value

Type	Description
System.Int32	The number of columns that is displayed in the color picker palette. The default value is 10.

Default

Specifies the color value that is displayed by default in the color picker.

Declaration

public virtual string Default { get; set; }

Property Value

Type
System.String

Mode

Gets or sets the color picker default rendering palette or picker mode.

Declaration

public ColorPickerMode Mode { get; set; }

Property Value

Type	Description
ColorPickerMode	One of the ColorPickerMode enumeration. The default value is Palette

Remarks

If the ColorPickerMode is Palette, the color picker popup display as color palette. If the ColorPickerMode is Picker, the color picker popup display as color picking panel.

ModeSwitcher

Gets or sets whether to enable or disable the color picker diaplay mode switcher button.

Declaration

public bool ModeSwitcher { get; set; }

Property Value

Type	Description
System.Boolean	true, if the diaplay mode switcher button is enabled for color picker. otherwise, false.The default value is false.

Parent

A class is used to configure the quick toolbar settings in the Rich Text Editor.

Declaration

protected SfRichTextEditor Parent { get; set; }

Property Value

Type
SfRichTextEditor

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.

GetColorType()

Used to get the Color type.

Declaration

protected virtual string GetColorType()

Returns

Type	Description
System.String	Returns the dropdown type.

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.

PropertyChangeHandler(Dictionary<String, Object>.KeyCollection)

Used to handle the dynamic property changes.

Declaration

protected virtual void PropertyChangeHandler(Dictionary<string, object>.KeyCollection keys)

Parameters

Type	Name	Description
System.Collections.Generic.Dictionary.KeyCollection<>	keys	Specifies the changed keys.