Class DashboardLayoutPanel

Specifies the DashboardLayoutPanel.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
DashboardLayoutPanel
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Layouts
Assembly: Syncfusion.Blazor.dll
Syntax
public class DashboardLayoutPanel : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

DashboardLayoutPanel()

Declaration
public DashboardLayoutPanel()

Properties

AllowDragging

Gets or sets the dragging panel.

Declaration
[Parameter]
public bool AllowDragging { get; set; }
Property Value
Type Description
bool

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
[Parameter]
public int Column { get; set; }
Property Value
Type Description
int

Accepts an integer value.

Content

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

Declaration
[Parameter]
[JsonIgnore]
public RenderFragment Content { get; set; }
Property Value
Type Description
RenderFragment

The panel content. The default value in null.

ContentTemplate

Gets or sets the ContentTemplate of the panels.

Declaration
[Parameter]
[JsonIgnore]
public RenderFragment ContentTemplate { get; set; }
Property Value
Type Description
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
[Parameter]
public string CssClass { get; set; }
Property Value
Type Description
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
[Parameter]
public bool Enabled { get; set; }
Property Value
Type Description
bool

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
[Parameter]
[JsonIgnore]
public RenderFragment Header { get; set; }
Property Value
Type Description
RenderFragment

The header content. The default value in null.

HeaderTemplate

Gets or sets the HeaderTemplate of the panels.

Declaration
[Parameter]
[JsonIgnore]
public RenderFragment HeaderTemplate { get; set; }
Property Value
Type Description
RenderFragment

The header template content. The default value in null.

Id

Gets or sets the id of the panel.

Declaration
[Parameter]
public string Id { get; set; }
Property Value
Type Description
string

The default value in String.Empty.

MaxSizeX

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

Declaration
[Parameter]
public int? MaxSizeX { get; set; }
Property Value
Type Description
int?

The default value in null.

MaxSizeY

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

Declaration
[Parameter]
public int? MaxSizeY { get; set; }
Property Value
Type Description
int?

The default value in null.

MinSizeX

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

Declaration
[Parameter]
public int MinSizeX { get; set; }
Property Value
Type Description
int

The default value in 1.

MinSizeY

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

Declaration
[Parameter]
public int MinSizeY { get; set; }
Property Value
Type Description
int

The default value in 1.

Row

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

Declaration
[Parameter]
public int Row { get; set; }
Property Value
Type Description
int

Accepts an integer value.

SizeX

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

Declaration
[Parameter]
public int SizeX { get; set; }
Property Value
Type Description
int

The default value in 1.

SizeY

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

Declaration
[Parameter]
public int SizeY { get; set; }
Property Value
Type Description
int

The default value in 1.

ZIndex

Gets or sets the z-index of the panel.

Declaration
[Parameter]
public double ZIndex { get; set; }
Property Value
Type Description
double

The default value in 1000.

ijsRuntime

Declaration
[Inject]
protected IJSRuntime? ijsRuntime { get; set; }
Property Value
Type
IJSRuntime

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

Dispose(bool)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing
Overrides

GetIdValues(DashboardLayoutPanel)

Get the panel id values.

Declaration
protected void GetIdValues(DashboardLayoutPanel panel)
Parameters
Type Name Description
DashboardLayoutPanel panel

panel.

OnAfterRenderAsync(bool)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
Type Name Description
bool firstRender
Returns
Type
Task
Overrides

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

PreventRender(bool)

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

Declaration
public void PreventRender(bool preventRender = true)
Parameters
Type Name Description
bool 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
bool
Overrides

Implements