Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfInPlaceEditor<TValue> - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfInPlaceEditor<TValue>

    The In-place Editor component is most useful for editing a value dynamically within its context (in-place). It has the built-in support to handle all the form components, including TextBox, Dropdown List, DatePicker, and Rich Text Editor. The component comes with different edit modes and a fully customizable UI.

    Inheritance
    System.Object
    Syncfusion.Blazor.SfBaseComponent
    SfInPlaceEditor<TValue>
    Namespace: Syncfusion.Blazor.InPlaceEditor
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class SfInPlaceEditor<TValue> : SfBaseComponent, IInPlaceEditor
    Type Parameters
    Name Description
    TValue

    Constructors

    SfInPlaceEditor()

    Declaration
    public SfInPlaceEditor()

    Properties

    ActionOnBlur

    Specifies the action that is performed when we focus-out from the In-place Editor. It can be a Submit or Cancel or Ignore action.

    Declaration
    public ActionBlur ActionOnBlur { get; set; }
    Property Value
    Type Description
    ActionBlur

    Adaptor

    Specifies the adaptor type that is used by the DataManager to communicate with DataSource.

    Declaration
    public Adaptors Adaptor { get; set; }
    Property Value
    Type Description
    Adaptors

    CancelButton

    Declaration
    public InPlaceEditorCancelButton CancelButton { get; set; }
    Property Value
    Type Description
    InPlaceEditorCancelButton

    ChildContent

    Declaration
    public RenderFragment ChildContent { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment

    CssClass

    Defines single or multiple classes (separated by space) to be used to customize the In-place Editor.

    Declaration
    public string CssClass { get; set; }
    Property Value
    Type Description
    System.String

    Disabled

    Specifies whether to enable or disable the In-place Editor.

    Declaration
    public bool Disabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    EditableOn

    Specifies whether to enable or disable the editing mode.

    Declaration
    public EditableType EditableOn { get; set; }
    Property Value
    Type Description
    EditableType

    EmptyText

    Sets the text to be shown when a component is Empty.

    Declaration
    public string EmptyText { get; set; }
    Property Value
    Type Description
    System.String

    EnableEditMode

    Specifies to show and hide the editing mode

    Declaration
    public bool EnableEditMode { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableHtmlSanitizer

    Defines whether to allow the cross-scripting site or not.

    Declaration
    public bool EnableHtmlSanitizer { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnablePersistence

    Enable or disable persisting component's state between page reloads.

    Declaration
    public bool EnablePersistence { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableRtl

    Enable or disable the rendering component in the right to left (RTL) direction.

    Declaration
    public bool EnableRtl { get; set; }
    Property Value
    Type Description
    System.Boolean

    HtmlAttributes

    You can add the additional Html attributes such as id, title, etc., to the InPlaceEditor element.

    Declaration
    public Dictionary<string, object> HtmlAttributes { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.Dictionary<System.String, System.Object>

    ID

    Overridden

    Declaration
    public string ID { get; set; }
    Property Value
    Type Description
    System.String

    InPlaceEditContext

    Declaration
    protected EditContext InPlaceEditContext { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.Forms.EditContext

    Locale

    Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

    Declaration
    public string Locale { get; set; }
    Property Value
    Type Description
    System.String

    Mode

    Specifies how to render its components whether in inline or popup mode while editing in the In-place Editor.

    Declaration
    public RenderMode Mode { get; set; }
    Property Value
    Type Description
    RenderMode

    Model

    Declaration
    public object Model { get; set; }
    Property Value
    Type Description
    System.Object

    Name

    Specifies the name of the component which is used to retrieve data from the server. If the name is not given, then the component ID will be considered as the mapping name.

    Declaration
    public string Name { get; set; }
    Property Value
    Type Description
    System.String

    PopupSettings

    Declaration
    public object PopupSettings { get; set; }
    Property Value
    Type Description
    System.Object

    PrimaryKey

    Defines the unique key of an editable field that can be used for saving data in the Database.

    Declaration
    public string PrimaryKey { get; set; }
    Property Value
    Type Description
    System.String

    SaveButton

    Declaration
    public object SaveButton { get; set; }
    Property Value
    Type Description
    System.Object

    SaveUrl

    Specifies the server URL which triggers on submit action in the In-place Editor.

    Declaration
    public string SaveUrl { get; set; }
    Property Value
    Type Description
    System.String

    ShowButtons

    Specifies whether to show or hide the Save and Cancel buttons of the In-place Editor.

    Declaration
    public bool ShowButtons { get; set; }
    Property Value
    Type Description
    System.Boolean

    SubmitOnEnter

    Enables to trigger the submit action when the enter key is pressed.

    Declaration
    public bool SubmitOnEnter { get; set; }
    Property Value
    Type Description
    System.Boolean

    Template

    Declaration
    public object Template { get; set; }
    Property Value
    Type Description
    System.Object

    TextOption

    Declaration
    public TextOptionType TextOption { get; set; }
    Property Value
    Type Description
    TextOptionType

    Type

    Specifies the component which is rendered within the In-place Editor.

    Declaration
    public InputType Type { get; set; }
    Property Value
    Type Description
    InputType

    Url

    Declaration
    public string Url { get; set; }
    Property Value
    Type Description
    System.String

    ValidationRules

    Declaration
    public object ValidationRules { get; set; }
    Property Value
    Type Description
    System.Object

    Value

    Specifies the display value for the component when the original value is empty.

    Declaration
    public TValue Value { get; set; }
    Property Value
    Type Description
    TValue

    ValueChanged

    Specifies the callback to trigger when the value changes in the In-place Editor.

    Declaration
    public EventCallback<TValue> ValueChanged { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<TValue>

    ValueExpression

    Specifies the expression for defining the value of the bound.

    Declaration
    public Expression<Func<TValue>> ValueExpression { get; set; }
    Property Value
    Type Description
    System.Linq.Expressions.Expression<System.Func<TValue>>

    Methods

    BuildRenderTree(RenderTreeBuilder)

    Declaration
    protected override void BuildRenderTree(RenderTreeBuilder __builder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

    ExtendModelValue(Object)

    Declaration
    public Task ExtendModelValue(object val)
    Parameters
    Type Name Description
    System.Object val
    Returns
    Type Description
    System.Threading.Tasks.Task

    OnAfterRenderAsync(Boolean)

    Declaration
    protected override Task OnAfterRenderAsync(bool firstRender)
    Parameters
    Type Name Description
    System.Boolean firstRender
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    Syncfusion.Blazor.SfBaseComponent.OnAfterRenderAsync(System.Boolean)

    OnInitializedAsync()

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    Syncfusion.Blazor.SfBaseComponent.OnInitializedAsync()

    OnParametersSetAsync()

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task

    Save()

    Submit the edited input value to the server.

    Declaration
    public Task Save()
    Returns
    Type Description
    System.Threading.Tasks.Task

    SetValue()

    Declaration
    public Task SetValue()
    Returns
    Type Description
    System.Threading.Tasks.Task

    UpdateCancelButton(InPlaceEditorCancelButton)

    Declaration
    public void UpdateCancelButton(InPlaceEditorCancelButton button)
    Parameters
    Type Name Description
    InPlaceEditorCancelButton button

    UpdateComponent(EditorComponent)

    Declaration
    public void UpdateComponent(EditorComponent component)
    Parameters
    Type Name Description
    EditorComponent component

    UpdatePopupSettings(InPlaceEditorPopupSettings)

    Declaration
    public void UpdatePopupSettings(InPlaceEditorPopupSettings popupSettings)
    Parameters
    Type Name Description
    InPlaceEditorPopupSettings popupSettings

    UpdateSaveButton(InPlaceEditorSaveButton)

    Declaration
    public void UpdateSaveButton(InPlaceEditorSaveButton button)
    Parameters
    Type Name Description
    InPlaceEditorSaveButton button

    UpdateTemplate(InPlaceEditorTemplate)

    Declaration
    public void UpdateTemplate(InPlaceEditorTemplate component)
    Parameters
    Type Name Description
    InPlaceEditorTemplate component

    Validate()

    Declaration
    public Task Validate()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved