Show / Hide Table of Contents

Class IgbListPanel

Inheritance
System.Object
BaseRendererControl
IgbListPanel
Implements
JsonSerializable
System.IDisposable
Inherited Members
BaseRendererControl.eventCallbacksCache
BaseRendererControl._cachedSerializedContent
BaseRendererControl.ResolveEventBehavior()
BaseRendererControl.ResolveDisplay()
BaseRendererControl.ToSpinal(String)
BaseRendererControl.TransformSimpleKey(String)
BaseRendererControl.IsTransformedEnumValue(String)
BaseRendererControl.TransformPotentialEnumValue(String, Object)
BaseRendererControl.BuildSequenceInfo(Int32)
BaseRendererControl.BuildRenderTree(RenderTreeBuilder)
BaseRendererControl.TemplateContentType(String)
BaseRendererControl.OnAfterRenderAsync(Boolean)
BaseRendererControl.EnsureReady()
BaseRendererControl.MarkPropDirty(String)
BaseRendererControl.IsPropDirty(String)
BaseRendererControl.Serialize(SerializationContext, String)
BaseRendererControl.Serialize()
BaseRendererControl.InvokeMethod(String, Object[], String[], ElementReference[])
BaseRendererControl.InvokeMethodSync(String, Object[], String[], ElementReference[])
BaseRendererControl.SuspendNotifications(Object)
BaseRendererControl.ResumeNotifications(Object, Boolean)
BaseRendererControl.NotifyInsertItem(Object, Int32, Object)
BaseRendererControl.NotifyRemoveItem(Object, Int32, Object)
BaseRendererControl.NotifyClearItems(Object)
BaseRendererControl.NotifySetItem(Object, Int32, Object, Object)
BaseRendererControl.NotifyUpdateItem(Object, Int32, Object, Boolean)
BaseRendererControl.OnRefChanged(String, Object)
BaseRendererControl.OnInvokeReturn(Int64, Object)
BaseRendererControl.Camelize(String)
BaseRendererControl.ToPascal(String)
BaseRendererControl.OnElementNameChanged(BaseRendererElement, String, String)
BaseRendererControl.Dispose(Boolean)
BaseRendererControl.SetResourceStringAsync(String, String, String)
BaseRendererControl.SetResourceStringAsync(String, String)
BaseRendererControl.SetPropertyValue(Object, PropertyInfo, JsonElement)
BaseRendererControl.SetPropertyValue(Object, PropertyInfo, Object)
BaseRendererControl.CompareEventCallbacks<T>(T, T, Dictionary<Type, Dictionary<String, FieldInfo>>)
BaseRendererControl.Finalize()
BaseRendererControl.Dispose()
BaseRendererControl.IgBlazor
BaseRendererControl.Height
BaseRendererControl.Width
BaseRendererControl.Class
BaseRendererControl.AdditionalAttributes
BaseRendererControl.ParentTypeName
BaseRendererControl.EventBehavior
BaseRendererControl.ChildContent
BaseRendererControl.RoundTripDateConversion
BaseRendererControl.SupportsVisualChildren
BaseRendererControl.UseDirectRender
BaseRendererControl.DirectRenderElementName
BaseRendererControl.NeedsDynamicContent
BaseRendererControl.UseCamelEnumValues
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbListPanel : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbListPanel()

Declaration
public IgbListPanel()

Properties

ActivationBorder

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

ActivationBorderBottomWidth

Declaration
public int ActivationBorderBottomWidth { get; set; }
Property Value
Type Description
System.Int32

ActivationBorderLeftWidth

Declaration
public int ActivationBorderLeftWidth { get; set; }
Property Value
Type Description
System.Int32

ActivationBorderRightWidth

Declaration
public int ActivationBorderRightWidth { get; set; }
Property Value
Type Description
System.Int32

ActivationBorderTopWidth

Declaration
public int ActivationBorderTopWidth { get; set; }
Property Value
Type Description
System.Int32

ActivationMode

Declaration
public ListPanelActivationMode ActivationMode { get; set; }
Property Value
Type Description
ListPanelActivationMode

ActiveRow

Declaration
public int ActiveRow { get; set; }
Property Value
Type Description
System.Int32

ActiveRowChanged

Declaration
public Action<IgbListPanelActiveRowChangedEventArgs> ActiveRowChanged { get; set; }
Property Value
Type Description
System.Action<IgbListPanelActiveRowChangedEventArgs>

ActiveRowChangedScript

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

ActualPrimaryKey

Declaration
public string[] ActualPrimaryKey { get; set; }
Property Value
Type Description
System.String[]

ActualPrimaryKeyChanged

Declaration
public EventCallback<string[]> ActualPrimaryKeyChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<System.String[]>

ActualPrimaryKeyChangedScript

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

ActualRowHeight

Declaration
public double ActualRowHeight { get; set; }
Property Value
Type Description
System.Double

BackgroundColor

Gets or sets the color to use for the background of the component.

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

CellFontFamily

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

CellFontSize

Declaration
public double CellFontSize { get; set; }
Property Value
Type Description
System.Double

CellFontStyle

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

CellFontWeight

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

ContentRefreshed

Declaration
public Action<IgbListPanelContentRefreshedEventArgs> ContentRefreshed { get; set; }
Property Value
Type Description
System.Action<IgbListPanelContentRefreshedEventArgs>

ContentRefreshedScript

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

DataSource

Gets or sets the data to which to bind the grid. This can be some type of array or list, or it can be an IDataSource instance.

Declaration
public object DataSource { get; set; }
Property Value
Type Description
System.Object

DataSourceScript

Provides a means of setting DataSource in the JavaScript environment.

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

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides
BaseRendererControl.DefaultEventBehavior

IsActiveRowStyleEnabled

Declaration
public bool IsActiveRowStyleEnabled { get; set; }
Property Value
Type Description
System.Boolean

IsCustomRowHeightEnabled

Gets or sets the color to use for the background of the component.

Declaration
public bool IsCustomRowHeightEnabled { get; set; }
Property Value
Type Description
System.Boolean

ItemClicked

Declaration
public EventCallback<IgbListPanelItemEventArgs> ItemClicked { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbListPanelItemEventArgs>

ItemClickedScript

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

ItemHeightRequested

Declaration
public EventCallback<IgbListPanelTemplateHeightRequestedEventArgs> ItemHeightRequested { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbListPanelTemplateHeightRequestedEventArgs>

ItemHeightRequestedScript

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

ItemRebind

Declaration
public Action<IgbListPanelContentRebindEventArgs> ItemRebind { get; set; }
Property Value
Type Description
System.Action<IgbListPanelContentRebindEventArgs>

ItemRebindScript

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

ItemRecycled

Declaration
public Action<IgbListPanelContentRecycledEventArgs> ItemRecycled { get; set; }
Property Value
Type Description
System.Action<IgbListPanelContentRecycledEventArgs>

ItemRecycledScript

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

ItemSpacing

Declaration
public double ItemSpacing { get; set; }
Property Value
Type Description
System.Double

ItemWidthRequested

Declaration
public EventCallback<IgbListPanelTemplateWidthRequestedEventArgs> ItemWidthRequested { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbListPanelTemplateWidthRequestedEventArgs>

ItemWidthRequestedScript

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

NormalBackground

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

NotifyOnAllSelectionChanges

Declaration
public bool NotifyOnAllSelectionChanges { get; set; }
Property Value
Type Description
System.Boolean

Orientation

Gets or sets the color to use for the background of the component.

Declaration
public ListPanelOrientation Orientation { get; set; }
Property Value
Type Description
ListPanelOrientation

PrimaryKey

Declaration
public string[] PrimaryKey { get; set; }
Property Value
Type Description
System.String[]

RowHeight

Gets or Sets the property name that contains the values.

Declaration
public int RowHeight { get; set; }
Property Value
Type Description
System.Int32

RowUpdating

Declaration
public EventCallback<IgbListPanelTemplateItemUpdatingEventArgs> RowUpdating { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbListPanelTemplateItemUpdatingEventArgs>

RowUpdatingScript

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

SchemaIncludedProperties

Declaration
public string[] SchemaIncludedProperties { get; set; }
Property Value
Type Description
System.String[]

ScrollbarBackground

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

ScrollbarStyle

Declaration
public ScrollbarStyle ScrollbarStyle { get; set; }
Property Value
Type Description
ScrollbarStyle

SelectedBackground

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

SelectedItems

Declaration
public IgbListPanelSelectedItemsCollection SelectedItems { get; protected set; }
Property Value
Type Description
IgbListPanelSelectedItemsCollection

SelectedItemsChanged

Declaration
public Action<IgbListPanelSelectedItemsChangedEventArgs> SelectedItemsChanged { get; set; }
Property Value
Type Description
System.Action<IgbListPanelSelectedItemsChangedEventArgs>

SelectedItemsChangedScript

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

SelectedKeys

Declaration
public IgbListPanelSelectedKeysCollection SelectedKeys { get; protected set; }
Property Value
Type Description
IgbListPanelSelectedKeysCollection

SelectedKeysChanged

Declaration
public Action<IgbListPanelSelectedKeysChangedEventArgs> SelectedKeysChanged { get; set; }
Property Value
Type Description
System.Action<IgbListPanelSelectedKeysChangedEventArgs>

SelectedKeysChangedScript

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

SelectionBehavior

Declaration
public ListPanelSelectionBehavior SelectionBehavior { get; set; }
Property Value
Type Description
ListPanelSelectionBehavior

SelectionChanged

Declaration
public Action<IgbListPanelSelectionChangedEventArgs> SelectionChanged { get; set; }
Property Value
Type Description
System.Action<IgbListPanelSelectionChangedEventArgs>

SelectionChangedScript

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

SelectionMode

Declaration
public ListPanelSelectionMode SelectionMode { get; set; }
Property Value
Type Description
ListPanelSelectionMode

TextColor

Gets or sets the color to use for the text of the component.

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

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides
BaseRendererControl.Type

Methods

DataIndexOfItem(Object)

Declaration
public int DataIndexOfItem(object item)
Parameters
Type Name Description
System.Object item
Returns
Type Description
System.Int32

DataIndexOfItemAsync(Object)

Returns the data index of an item within the bound data source.

Declaration
public Task<int> DataIndexOfItemAsync(object item)
Parameters
Type Name Description
System.Object item

The item from which to get the index.

Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

DeselectAllRows()

Declaration
public void DeselectAllRows()

DeselectAllRowsAsync()

Declaration
public Task DeselectAllRowsAsync()
Returns
Type Description
System.Threading.Tasks.Task

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides
BaseRendererControl.EnsureModulesLoaded()

ExportSerializedVisualData()

Declaration
public string ExportSerializedVisualData()
Returns
Type Description
System.String

ExportSerializedVisualDataAsync()

Declaration
public Task<string> ExportSerializedVisualDataAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

ExportVisualData()

Declaration
public object ExportVisualData()
Returns
Type Description
System.Object

ExportVisualDataAsync()

Declaration
public Task<object> ExportVisualDataAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides
BaseRendererControl.FindByName(String)

GetCurrentActiveRow()

Declaration
public int GetCurrentActiveRow()
Returns
Type Description
System.Int32

GetCurrentActiveRowAsync()

Declaration
public Task<int> GetCurrentActiveRowAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

GetCurrentActualPrimaryKey()

Declaration
public string[] GetCurrentActualPrimaryKey()
Returns
Type Description
System.String[]

GetCurrentActualPrimaryKeyAsync()

Declaration
public Task<string[]> GetCurrentActualPrimaryKeyAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String[]>

GetCurrentSelectedItems()

Declaration
public IgbListPanelSelectedItemsCollection GetCurrentSelectedItems()
Returns
Type Description
IgbListPanelSelectedItemsCollection

GetCurrentSelectedItemsAsync()

Declaration
public Task<IgbListPanelSelectedItemsCollection> GetCurrentSelectedItemsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbListPanelSelectedItemsCollection>

GetCurrentSelectedKeys()

Declaration
public IgbListPanelSelectedKeysCollection GetCurrentSelectedKeys()
Returns
Type Description
IgbListPanelSelectedKeysCollection

GetCurrentSelectedKeysAsync()

Declaration
public Task<IgbListPanelSelectedKeysCollection> GetCurrentSelectedKeysAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbListPanelSelectedKeysCollection>

GetFirstVisibleIndex()

Declaration
public int GetFirstVisibleIndex()
Returns
Type Description
System.Int32

GetFirstVisibleIndexAsync()

Gets the first visible index in the grid.

Declaration
public Task<int> GetFirstVisibleIndexAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

GetItemKey(String[], Object)

Declaration
public IgbListPanelPrimaryKeyValue GetItemKey(string[] primaryKey, object item_)
Parameters
Type Name Description
System.String[] primaryKey
System.Object item_
Returns
Type Description
IgbListPanelPrimaryKeyValue

GetItemKeyAsync(String[], Object)

Declaration
public Task<IgbListPanelPrimaryKeyValue> GetItemKeyAsync(string[] primaryKey, object item_)
Parameters
Type Name Description
System.String[] primaryKey
System.Object item_
Returns
Type Description
System.Threading.Tasks.Task<IgbListPanelPrimaryKeyValue>

GetLastVisibleIndex()

Declaration
public int GetLastVisibleIndex()
Returns
Type Description
System.Int32

GetLastVisibleIndexAsync()

Gets the last visible index in the grid.

Declaration
public Task<int> GetLastVisibleIndexAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

GetRowKey(String[], Int32)

Declaration
public IgbListPanelPrimaryKeyValue GetRowKey(string[] primaryKey, int rowIndex)
Parameters
Type Name Description
System.String[] primaryKey
System.Int32 rowIndex
Returns
Type Description
IgbListPanelPrimaryKeyValue

GetRowKeyAsync(String[], Int32)

Declaration
public Task<IgbListPanelPrimaryKeyValue> GetRowKeyAsync(string[] primaryKey, int rowIndex)
Parameters
Type Name Description
System.String[] primaryKey
System.Int32 rowIndex
Returns
Type Description
System.Threading.Tasks.Task<IgbListPanelPrimaryKeyValue>

InvalidateVisibleItems()

Declaration
public void InvalidateVisibleItems()

InvalidateVisibleItemsAsync()

Invalidates the bound data for the rows currently visible.

Declaration
public Task InvalidateVisibleItemsAsync()
Returns
Type Description
System.Threading.Tasks.Task

ScrollToLastRowByIndex(Double)

Declaration
public void ScrollToLastRowByIndex(double rowNumber)
Parameters
Type Name Description
System.Double rowNumber

ScrollToLastRowByIndexAsync(Double)

Declaration
public Task ScrollToLastRowByIndexAsync(double rowNumber)
Parameters
Type Name Description
System.Double rowNumber
Returns
Type Description
System.Threading.Tasks.Task

ScrollToRowByIndex(Double)

Declaration
public void ScrollToRowByIndex(double rowNumber)
Parameters
Type Name Description
System.Double rowNumber

ScrollToRowByIndexAsync(Double)

Declaration
public Task ScrollToRowByIndexAsync(double rowNumber)
Parameters
Type Name Description
System.Double rowNumber
Returns
Type Description
System.Threading.Tasks.Task

SelectAllRows()

Declaration
public void SelectAllRows()

SelectAllRowsAsync()

Declaration
public Task SelectAllRowsAsync()
Returns
Type Description
System.Threading.Tasks.Task

Implements

JsonSerializable
System.IDisposable