Class DashboardLayoutPanel

Specifies the DashboardLayoutPanel.

Inheritance

System.Object

DashboardLayoutPanel

Namespace: Syncfusion.Blazor.Layouts

Assembly: Syncfusion.Blazor.dll

Syntax

public class DashboardLayoutPanel : OwningComponentBase

Constructors

DashboardLayoutPanel()

Declaration

public DashboardLayoutPanel()

Properties

AllowDragging

Gets or sets the dragging panel.

Declaration

public bool AllowDragging { get; set; }

Property Value

Type	Description
System.Boolean	false if dragging must be restricted. The default value in true.

Column

Gets or sets the column value where the panel to be placed.

Declaration

public int Column { get; set; }

Property Value

Type	Description
System.Int32	Accepts an integer value.

Content

Gets or sets the value that should be displayed as the panel's content.

Declaration

public RenderFragment Content { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	The panel content. The default value in null.

ContentTemplate

Gets or sets the ContentTemplate of the panels.

Declaration

public RenderFragment ContentTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	The panel template content. The default value in null.

CssClass

Gets or sets the CSS class name that can be appended with each panel element.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	Custom class names can be added. The default value in String.Empty.

Enabled

Gets or sets whether the panel should be enabled or not.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean	false if the panels must be disabled. The default value in true.

Header

Gets or sets the value that should be displayed as the panel's header.

Declaration

public RenderFragment Header { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	The header content. The default value in null.

HeaderTemplate

Gets or sets the HeaderTemplate of the panels.

Declaration

public RenderFragment HeaderTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	The header template content. The default value in null.

Id

Gets or sets the id of the panel.

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String	The default value in String.Empty.

ijsRuntime

Declaration

protected IJSRuntime ijsRuntime { get; set; }

Property Value

Type
Microsoft.JSInterop.IJSRuntime

MaxSizeX

Gets or sets the maximum width of the panel in cells count.

Declaration

public Nullable<int> MaxSizeX { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The default value in null.

MaxSizeY

Gets or sets the maximum height of the panel in cells count.

Declaration

public Nullable<int> MaxSizeY { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	The default value in null.

MinSizeX

Gets or sets the minimum width of the panel in cells count.

Declaration

public int MinSizeX { get; set; }

Property Value

Type	Description
System.Int32	The default value in 1.

MinSizeY

Gets or sets the minimum height of the panel in cells count.

Declaration

public int MinSizeY { get; set; }

Property Value

Type	Description
System.Int32	The default value in 1.

Row

Gets or sets a row value where the panel should be placed.

Declaration

public int Row { get; set; }

Property Value

Type	Description
System.Int32	Accepts an integer value.

SizeX

Gets or sets the width of the panel in the layout in cells count.

Declaration

public int SizeX { get; set; }

Property Value

Type	Description
System.Int32	The default value in 1.

SizeY

Gets or sets the height of the panel in the layout in cells count.

Declaration

public int SizeY { get; set; }

Property Value

Type	Description
System.Int32	The default value in 1.

ZIndex

Gets or sets the z-index of the panel.

Declaration

public double ZIndex { get; set; }

Property Value

Type	Description
System.Double	The default value in 1000.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

GetIdValues(DashboardLayoutPanel)

Get the panel id values.

Declaration

protected void GetIdValues(DashboardLayoutPanel panel)

Parameters

Type	Name	Description
DashboardLayoutPanel	panel	panel.

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type
System.Threading.Tasks.Task

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
System.Threading.Tasks.Task

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type
System.Threading.Tasks.Task

PreventRender(Boolean)

Controls the re-rendering behavior of the Dashboard Layout component.

Declaration

public void PreventRender(bool preventRender = true)

Parameters

Type	Name	Description
System.Boolean	preventRender	Optional. Determines whether the component should be prevented from re-rendering. Default value is true.

Remarks

This method internally sets the value to be returned by the ShouldRender method. By default, this method prevents the component from rendering. To enable rendering again, set preventRender to false.

ShouldRender()

Declaration

protected override bool ShouldRender()

Returns

Type
System.Boolean