ASP.NET MVC - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class DashboardLayoutBuilder

    Show / Hide Table of Contents

    Class DashboardLayoutBuilder

    Inheritance
    System.Object
    ControlBuilder
    DashboardLayoutBuilder
    Inherited Members
    ControlBuilder.Context
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.EJ2.Layouts
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class DashboardLayoutBuilder : ControlBuilder

    Constructors

    DashboardLayoutBuilder()

    Declaration
    public DashboardLayoutBuilder()

    DashboardLayoutBuilder(DashboardLayout)

    Declaration
    public DashboardLayoutBuilder(DashboardLayout model)
    Parameters
    Type Name Description
    DashboardLayout model

    Fields

    model

    Declaration
    public DashboardLayout model
    Field Value
    Type Description
    DashboardLayout

    Properties

    HtmlAttr

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

    ID

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

    Output

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

    Methods

    AllowDragging(Boolean)

    If allowDragging is set to true, then the DashboardLayout allows you to drag and reorder the panels.

    Declaration
    public DashboardLayoutBuilder AllowDragging(bool allowDragging = true)
    Parameters
    Type Name Description
    System.Boolean allowDragging
    Returns
    Type Description
    DashboardLayoutBuilder

    AllowFloating(Boolean)

    If allowFloating is set to true, then the DashboardLayout automatically move the panels upwards to fill the empty available cells while dragging or resizing the panels.

    Declaration
    public DashboardLayoutBuilder AllowFloating(bool allowFloating = true)
    Parameters
    Type Name Description
    System.Boolean allowFloating
    Returns
    Type Description
    DashboardLayoutBuilder

    AllowResizing(Boolean)

    If allowResizing is set to true, then the DashboardLayout allows you to resize the panels.

    Declaration
    public DashboardLayoutBuilder AllowResizing(bool allowResizing = true)
    Parameters
    Type Name Description
    System.Boolean allowResizing
    Returns
    Type Description
    DashboardLayoutBuilder

    CellAspectRatio(Double)

    Defines the cell aspect ratio of the panel.

    Declaration
    public DashboardLayoutBuilder CellAspectRatio(double cellAspectRatio)
    Parameters
    Type Name Description
    System.Double cellAspectRatio
    Returns
    Type Description
    DashboardLayoutBuilder

    CellSpacing(Double[])

    Defines the spacing between the panels.

    Declaration
    public DashboardLayoutBuilder CellSpacing(double[] cellSpacing)
    Parameters
    Type Name Description
    System.Double[] cellSpacing
    Returns
    Type Description
    DashboardLayoutBuilder

    Change(String)

    Triggers whenever the panels positions are changed.

    Declaration
    public DashboardLayoutBuilder Change(string change)
    Parameters
    Type Name Description
    System.String change
    Returns
    Type Description
    DashboardLayoutBuilder

    Columns(Double)

    Defines the number of columns to be created in the DashboardLayout.

    Declaration
    public DashboardLayoutBuilder Columns(double columns)
    Parameters
    Type Name Description
    System.Double columns
    Returns
    Type Description
    DashboardLayoutBuilder

    ContentTemplate(Action<Object>)

    Declaration
    public DashboardLayoutBuilder ContentTemplate(Action<object> template)
    Parameters
    Type Name Description
    System.Action<System.Object> template
    Returns
    Type Description
    DashboardLayoutBuilder

    ContentTemplate(Func<Object, Object>)

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

    Created(String)

    Triggers when Dashboard Layout is created.

    Declaration
    public DashboardLayoutBuilder Created(string created)
    Parameters
    Type Name Description
    System.String created
    Returns
    Type Description
    DashboardLayoutBuilder

    Destroyed(String)

    Triggers when Dashboard Layout is destroyed.

    Declaration
    public DashboardLayoutBuilder Destroyed(string destroyed)
    Parameters
    Type Name Description
    System.String destroyed
    Returns
    Type Description
    DashboardLayoutBuilder

    Drag(String)

    Triggers while a panel is dragged continuously.

    Declaration
    public DashboardLayoutBuilder Drag(string drag)
    Parameters
    Type Name Description
    System.String drag
    Returns
    Type Description
    DashboardLayoutBuilder

    DraggableHandle(String)

    Defines the draggable handle selector which will act as dragging handler for the panels.

    Declaration
    public DashboardLayoutBuilder DraggableHandle(string draggableHandle)
    Parameters
    Type Name Description
    System.String draggableHandle
    Returns
    Type Description
    DashboardLayoutBuilder

    DragStart(String)

    Triggers when a panel is about to drag.

    Declaration
    public DashboardLayoutBuilder DragStart(string dragStart)
    Parameters
    Type Name Description
    System.String dragStart
    Returns
    Type Description
    DashboardLayoutBuilder

    DragStop(String)

    Triggers when a dragged panel is dropped.

    Declaration
    public DashboardLayoutBuilder DragStop(string dragStop)
    Parameters
    Type Name Description
    System.String dragStop
    Returns
    Type Description
    DashboardLayoutBuilder

    EnableHtmlSanitizer(Boolean)

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

    Declaration
    public DashboardLayoutBuilder EnableHtmlSanitizer(bool enableHtmlSanitizer = true)
    Parameters
    Type Name Description
    System.Boolean enableHtmlSanitizer
    Returns
    Type Description
    DashboardLayoutBuilder

    EnablePersistence(Boolean)

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

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

    EnableRtl(Boolean)

    Enable or disable rendering component in right to left direction.

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

    HtmlAttributes(Object)

    Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

    Declaration
    public DashboardLayoutBuilder HtmlAttributes(object htmlAttributes)
    Parameters
    Type Name Description
    System.Object htmlAttributes
    Returns
    Type Description
    DashboardLayoutBuilder

    MediaQuery(String)

    Defines the media query value where the dashboardlayout becomes stacked layout when the resolution meets.

    Declaration
    public DashboardLayoutBuilder MediaQuery(string mediaQuery)
    Parameters
    Type Name Description
    System.String mediaQuery
    Returns
    Type Description
    DashboardLayoutBuilder

    Panels(Action<DashboardLayoutPanelBuilder>)

    Declaration
    public DashboardLayoutBuilder Panels(Action<DashboardLayoutPanelBuilder> panels)
    Parameters
    Type Name Description
    System.Action<DashboardLayoutPanelBuilder> panels
    Returns
    Type Description
    DashboardLayoutBuilder

    Panels(List<DashboardLayoutPanel>)

    Defines the panels property of the DashboardLayout component.

    Declaration
    public DashboardLayoutBuilder Panels(List<DashboardLayoutPanel> panels)
    Parameters
    Type Name Description
    System.Collections.Generic.List<DashboardLayoutPanel> panels
    Returns
    Type Description
    DashboardLayoutBuilder

    Render()

    Declaration
    public HtmlString Render()
    Returns
    Type Description
    System.Web.HtmlString

    ResizableHandles(String[])

    Defines the resizing handles directions used for resizing the panels.

    Declaration
    public DashboardLayoutBuilder ResizableHandles(string[] resizableHandles)
    Parameters
    Type Name Description
    System.String[] resizableHandles
    Returns
    Type Description
    DashboardLayoutBuilder

    Resize(String)

    Triggers when a panel is being resized continuously.

    Declaration
    public DashboardLayoutBuilder Resize(string resize)
    Parameters
    Type Name Description
    System.String resize
    Returns
    Type Description
    DashboardLayoutBuilder

    ResizeStart(String)

    Triggers when a panel is about to resize.

    Declaration
    public DashboardLayoutBuilder ResizeStart(string resizeStart)
    Parameters
    Type Name Description
    System.String resizeStart
    Returns
    Type Description
    DashboardLayoutBuilder

    ResizeStop(String)

    Triggers when a panel resize ends.

    Declaration
    public DashboardLayoutBuilder ResizeStop(string resizeStop)
    Parameters
    Type Name Description
    System.String resizeStop
    Returns
    Type Description
    DashboardLayoutBuilder

    ShowGridLines(Boolean)

    Enables or disables the grid lines for the Dashboard Layout panels.

    Declaration
    public DashboardLayoutBuilder ShowGridLines(bool showGridLines = true)
    Parameters
    Type Name Description
    System.Boolean showGridLines
    Returns
    Type Description
    DashboardLayoutBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved