Class PopupBuilder

Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
PopupBuilder
Namespace: Syncfusion.EJ2.Popups
Assembly: Syncfusion.EJ2.dll
Syntax
public class PopupBuilder : ControlBuilder

Constructors

PopupBuilder()

Declaration
public PopupBuilder()

PopupBuilder(Popup)

Declaration
public PopupBuilder(Popup model)
Parameters
Type Name Description
Popup model

Properties

ID

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

Output

Declaration
public override TextWriter Output { get; set; }
Property Value
Type
System.IO.TextWriter
Overrides
Syncfusion.EJ2.ControlBuilder.Output

Methods

ActionOnScroll(ActionOnScrollType)

specifies the action that should happen when scroll the target-parent container. This property should define either reposition or hide. when set reposition to this property, the popup position will refresh when scroll any parent container. when set hide to this property, the popup will be closed when scroll any parent container.

Declaration
public PopupBuilder ActionOnScroll(ActionOnScrollType actionOnScroll)
Parameters
Type Name Description
ActionOnScrollType actionOnScroll
Returns
Type
PopupBuilder

Close(String)

Trigger the event once closed the popup.

Declaration
public PopupBuilder Close(string close)
Parameters
Type Name Description
System.String close
Returns
Type
PopupBuilder

Collision(Object)

Specifies the collision handler settings of the component.

Declaration
public PopupBuilder Collision(object collision)
Parameters
Type Name Description
System.Object collision
Returns
Type
PopupBuilder

Content(String)

Specifies the content of the popup element, it can be string or HTMLElement.

Declaration
public PopupBuilder Content(string content)
Parameters
Type Name Description
System.String content
Returns
Type
PopupBuilder

ContentTemplate(Func<Object, Object>)

Declaration
public PopupBuilder ContentTemplate(Func<object, object> template)
Parameters
Type Name Description
System.Func<System.Object, System.Object> template
Returns
Type
PopupBuilder

EnablePersistence(Boolean)

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

Declaration
public PopupBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type Name Description
System.Boolean enablePersistence
Returns
Type
PopupBuilder

EnableRtl(Boolean)

specifies the rtl direction state of the popup element.

Declaration
public PopupBuilder EnableRtl(bool enableRtl = true)
Parameters
Type Name Description
System.Boolean enableRtl
Returns
Type
PopupBuilder

Height(String)

Specifies the height of the popup element.

Declaration
public PopupBuilder Height(string height)
Parameters
Type Name Description
System.String height
Returns
Type
PopupBuilder

HideAnimation(Object)

specifies the animation that should happen when popup closes.

Declaration
public PopupBuilder HideAnimation(object hideAnimation)
Parameters
Type Name Description
System.Object hideAnimation
Returns
Type
PopupBuilder

Locale(String)

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

Declaration
public PopupBuilder Locale(string locale)
Parameters
Type Name Description
System.String locale
Returns
Type
PopupBuilder

OffsetX(Double)

specifies the popup element offset-x value, respective to the relative element.

Declaration
public PopupBuilder OffsetX(double offsetX)
Parameters
Type Name Description
System.Double offsetX
Returns
Type
PopupBuilder

OffsetY(Double)

specifies the popup element offset-y value, respective to the relative element.

Declaration
public PopupBuilder OffsetY(double offsetY)
Parameters
Type Name Description
System.Double offsetY
Returns
Type
PopupBuilder

Open(String)

Triggers the event once opened the popup.

Declaration
public PopupBuilder Open(string open)
Parameters
Type Name Description
System.String open
Returns
Type
PopupBuilder

Position(Object)

Specifies the popup element position, respective to the relative element.

Declaration
public PopupBuilder Position(object position)
Parameters
Type Name Description
System.Object position
Returns
Type
PopupBuilder

RelateTo(String)

Specifies the relative container element of the popup element.Based on the relative element, popup element will be positioned.

Declaration
public PopupBuilder RelateTo(string relateTo)
Parameters
Type Name Description
System.String relateTo
Returns
Type
PopupBuilder

Render()

Declaration
public HtmlString Render()
Returns
Type
Microsoft.AspNetCore.Html.HtmlString

ShowAnimation(Object)

specifies the animation that should happen when popup open.

Declaration
public PopupBuilder ShowAnimation(object showAnimation)
Parameters
Type Name Description
System.Object showAnimation
Returns
Type
PopupBuilder

TargetExitViewport(String)

Triggers the event when target element hide from view port on scroll.

Declaration
public PopupBuilder TargetExitViewport(string targetExitViewport)
Parameters
Type Name Description
System.String targetExitViewport
Returns
Type
PopupBuilder

TargetType(TargetType)

Specifies the relative element type of the component.

Declaration
public PopupBuilder TargetType(TargetType targetType)
Parameters
Type Name Description
TargetType targetType
Returns
Type
PopupBuilder

ViewPortElement(Object)

Specifies the collision detectable container element of the component.

Declaration
public PopupBuilder ViewPortElement(object viewPortElement)
Parameters
Type Name Description
System.Object viewPortElement
Returns
Type
PopupBuilder

Width(String)

Specifies the height of the popup element.

Declaration
public PopupBuilder Width(string width)
Parameters
Type Name Description
System.String width
Returns
Type
PopupBuilder

ZIndex(Double)

specifies the z-index value of the popup element.

Declaration
public PopupBuilder ZIndex(double zIndex)
Parameters
Type Name Description
System.Double zIndex
Returns
Type
PopupBuilder