Class InPlaceEditorPopupSettings

Configures the properties for customizing the popup mode of the Syncfusion.Blazor.InPlaceEditor.

Inheritance

System.Object

InPlaceEditorPopupSettings

Namespace: Syncfusion.Blazor.InPlaceEditor

Assembly: Syncfusion.Blazor.dll

Syntax

public class InPlaceEditorPopupSettings : OwningComponentBase

Remarks

This class allows you to define settings such as animation, position, and dimensions for the popup editor.

Examples

A simple In-place Editor component with popup settings.

<SfInPlaceEditor Mode="RenderMode.Popup">
    <InPlaceEditorPopupSettings Title="Enter Name" />
</SfInPlaceEditor>

Constructors

InPlaceEditorPopupSettings()

Declaration

public InPlaceEditorPopupSettings()

Properties

Animation

Gets or sets the animation settings for opening and closing the popup.

Declaration

public AnimationModel Animation { get; set; }

Property Value

Type	Description
AnimationModel	An AnimationModel object that defines the delay, duration, and effect for the popup animation.

Remarks

By default, the popup opens and closes with a fade effect.

CloseDelay

Gets or sets the duration in milliseconds to wait before closing the popup.

Declaration

public int CloseDelay { get; set; }

Property Value

Type	Description
System.Int32	An `int` representing the delay in milliseconds. The default value is 0.

CssClass

Gets or sets a user-defined CSS class to customize the popup's appearance.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	A `string` representing the CSS class. The default value is `null`.

Height

Gets or sets the height of the popup.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	A `string` that specifies the height. The default value is "auto".

HtmlAttributes

Gets or sets a collection of additional HTML attributes to be applied to the popup element.

Declaration

public Dictionary<string, object> HtmlAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	A System.Collections.Generic.Dictionary<, > where the key is a `string` representing the attribute name and the value is an `object` representing the attribute value.

IsSticky

Gets or sets a value indicating whether to keep the popup open until it is manually closed.

Declaration

public bool IsSticky { get; set; }

Property Value

Type	Description
System.Boolean	`true` to freeze the popup in an open state; otherwise, `false`. The default value is `false`.

OffsetX

Gets or sets the horizontal distance between the target element and the popup.

Declaration

public int OffsetX { get; set; }

Property Value

Type	Description
System.Int32	An `int` representing the X-coordinate offset. The default value is 0.

OffsetY

Gets or sets the vertical distance between the target element and the popup.

Declaration

public int OffsetY { get; set; }

Property Value

Type	Description
System.Int32	An `int` representing the Y-coordinate offset. The default value is 0.

OpenDelay

Gets or sets the duration in milliseconds to wait before opening the popup.

Declaration

public int OpenDelay { get; set; }

Property Value

Type	Description
System.Int32	An `int` representing the delay in milliseconds. The default value is 0.

OpensOn

Gets or sets the event that triggers the popup to open.

Declaration

public OpenType OpensOn { get; set; }

Property Value

Type	Description
OpenType	An OpenType enum value. The available modes are Auto, Hover, Click, Focus, and Custom.

Position

Gets or sets the position of the popup relative to the target element.

Declaration

public Position Position { get; set; }

Property Value

Type	Description
Position	A Position enum value. The default is TopCenter.

ShowTipPointer

Gets or sets a value indicating whether to display a tip pointer on the popup.

Declaration

public bool ShowTipPointer { get; set; }

Property Value

Type	Description
System.Boolean	`true` to show the tip pointer; otherwise, `false`. The default value is `true`.

TipPointerPosition

Gets or sets the position of the tip pointer on the popup.

Declaration

public TipPointerPosition TipPointerPosition { get; set; }

Property Value

Type	Description
TipPointerPosition	A TipPointerPosition enum value. The available options are Auto, Start, Middle, and End.

Remarks

When set to Auto, the tip pointer adjusts its position automatically based on the available space around the target.

Title

Gets or sets the title displayed in the popup header.

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String	A `string` representing the title text. The default value is `null`.

Width

Gets or sets the width of the popup.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	A `string` representing the width. The default value is "auto".

Remarks

When set to "auto", the popup width adjusts to fit its content within the viewable screen area.

Methods

Dispose()

Releases the unmanaged resources used by the component.

Declaration

public virtual void Dispose()

Dispose(Boolean)

Releases the unmanaged resources used by the component and optionally releases the managed resources.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	`true` to release both managed and unmanaged resources; `false` to release only unmanaged resources.

OnParametersSetAsync()

A protected method that is invoked when the component has received parameters from its parent component.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.