Class DashboardLayoutBuilder
Inheritance
System.Object
DashboardLayoutBuilder
Inherited Members
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()
Assembly: Syncfusion.EJ2.dll
Syntax
public class DashboardLayoutBuilder : ControlBuilder
Constructors
DashboardLayoutBuilder()
Declaration
public DashboardLayoutBuilder()
DashboardLayoutBuilder(DashboardLayout)
Declaration
public DashboardLayoutBuilder(DashboardLayout model)
Parameters
Fields
model
Declaration
public DashboardLayout model
Field Value
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
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
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
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
CellAspectRatio(Double)
Defines the cell aspect ratio of the panel.
Declaration
public DashboardLayoutBuilder CellAspectRatio(double cellAspectRatio)
Parameters
| Type |
Name |
Description |
| System.Double |
cellAspectRatio |
|
Returns
CellSpacing(Double[])
Defines the spacing between the panels.
Declaration
public DashboardLayoutBuilder CellSpacing(double[] cellSpacing)
Parameters
| Type |
Name |
Description |
| System.Double[] |
cellSpacing |
|
Returns
Change(String)
Triggers whenever the panels positions are changed.
Declaration
public DashboardLayoutBuilder Change(string change)
Parameters
| Type |
Name |
Description |
| System.String |
change |
|
Returns
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
ContentTemplate(Action<Object>)
Declaration
public DashboardLayoutBuilder ContentTemplate(Action<object> template)
Parameters
| Type |
Name |
Description |
| System.Action<System.Object> |
template |
|
Returns
ContentTemplate(Func<Object, Object>)
Declaration
public DashboardLayoutBuilder ContentTemplate(Func<object, object> template)
Parameters
| Type |
Name |
Description |
| System.Func<System.Object, System.Object> |
template |
|
Returns
Created(String)
Triggers when Dashboard Layout is created.
Declaration
public DashboardLayoutBuilder Created(string created)
Parameters
| Type |
Name |
Description |
| System.String |
created |
|
Returns
Destroyed(String)
Triggers when Dashboard Layout is destroyed.
Declaration
public DashboardLayoutBuilder Destroyed(string destroyed)
Parameters
| Type |
Name |
Description |
| System.String |
destroyed |
|
Returns
Drag(String)
Triggers while a panel is dragged continuously.
Declaration
public DashboardLayoutBuilder Drag(string drag)
Parameters
| Type |
Name |
Description |
| System.String |
drag |
|
Returns
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
DragStart(String)
Triggers when a panel is about to drag.
Declaration
public DashboardLayoutBuilder DragStart(string dragStart)
Parameters
| Type |
Name |
Description |
| System.String |
dragStart |
|
Returns
DragStop(String)
Triggers when a dragged panel is dropped.
Declaration
public DashboardLayoutBuilder DragStop(string dragStop)
Parameters
| Type |
Name |
Description |
| System.String |
dragStop |
|
Returns
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
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
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
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
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
Panels(Action<DashboardLayoutPanelBuilder>)
Declaration
public DashboardLayoutBuilder Panels(Action<DashboardLayoutPanelBuilder> panels)
Parameters
Returns
Panels(List<DashboardLayoutPanel>)
Defines the panels property of the DashboardLayout component.
Declaration
public DashboardLayoutBuilder Panels(List<DashboardLayoutPanel> panels)
Parameters
Returns
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
Resize(String)
Triggers when a panel is being resized continuously.
Declaration
public DashboardLayoutBuilder Resize(string resize)
Parameters
| Type |
Name |
Description |
| System.String |
resize |
|
Returns
ResizeStart(String)
Triggers when a panel is about to resize.
Declaration
public DashboardLayoutBuilder ResizeStart(string resizeStart)
Parameters
| Type |
Name |
Description |
| System.String |
resizeStart |
|
Returns
ResizeStop(String)
Triggers when a panel resize ends.
Declaration
public DashboardLayoutBuilder ResizeStop(string resizeStop)
Parameters
| Type |
Name |
Description |
| System.String |
resizeStop |
|
Returns
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