Class ChecklistBlockSettings

Gets or sets the placeholder text displayed when the checklist item has no content.

Inheritance

object

BlockSettings

ChecklistBlockSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Syncfusion.Blazor.BlockEditor

Assembly: Syncfusion.Blazor.dll

Syntax

public class ChecklistBlockSettings : BlockSettings

Remarks

If the value is null or empty, no placeholder text is rendered.

Provide localized text via resources to support multiple locales.

Examples

Demonstrates setting the placeholder for a checklist item.

<SfBlockEditor @bind-Blocks="Blocks" />
@code {
    private List<BlockModel> Blocks = new()
    {
        new BlockModel
        {
            ID = "task-2",
            BlockType = BlockType.Checklist,
            Properties = new ChecklistBlockSettings { Placeholder = "Add a task..." },
            Content = new List<ContentModel>
            {
                new ContentModel { ID = "task-2-content", ContentType = ContentType.Text, Content = string.Empty }
            }
        }
    };
}

Constructors

ChecklistBlockSettings()

Declaration

public ChecklistBlockSettings()

Properties

IsChecked

Gets or sets a value indicating whether a Checklist item is marked as completed in the SfBlockEditor.

Declaration

public bool IsChecked { get; set; }

Property Value

Type	Description
bool	A bool indicating the checked state of the checklist item. The default value is false.

Remarks

Set to true to render the item in a completed state. Users can toggle this state through the editor UI unless restricted by higher-level configuration.

This property is non-nullable. Synchronize updates with the editor�s change events to keep visuals and data consistent.

Performance: Toggling the checked state is a lightweight operation; rendering cost scales with the number of items displayed. Update from the UI thread for thread safety.

Placeholder

Gets or sets the placeholder text displayed when a Checklist item has no content in the SfBlockEditor.

Declaration

public string Placeholder { get; set; }

Property Value

Type	Description
string	A string representing the placeholder text shown for an empty checklist item. The default value is "" (empty string).

Remarks

Use this property to guide users on what to enter (for example, "Add a task..."). The placeholder is not displayed once the checklist item contains user-entered content.

If the value is null or empty, no placeholder text is rendered.

For localization, provide region-specific placeholder text via resource files to ensure a consistent experience across locales.