Class IgbListPanel
Inheritance
System.Object
IgbListPanel
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbListPanel : BaseRendererControl, RefSink, JsonSerializable, IDisposable
Constructors
IgbListPanel()
Declaration
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
ActiveRow
Declaration
public int ActiveRow { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
ActiveRowChanged
Declaration
public Action<IgbListPanelActiveRowChangedEventArgs> ActiveRowChanged { get; set; }
Property Value
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
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
Overrides
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
ItemClickedScript
Declaration
public string ItemClickedScript { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ItemHeightRequested
Declaration
public EventCallback<IgbListPanelTemplateHeightRequestedEventArgs> ItemHeightRequested { get; set; }
Property Value
ItemHeightRequestedScript
Declaration
public string ItemHeightRequestedScript { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ItemRebind
Declaration
public Action<IgbListPanelContentRebindEventArgs> ItemRebind { get; set; }
Property Value
ItemRebindScript
Declaration
public string ItemRebindScript { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ItemRecycled
Declaration
public Action<IgbListPanelContentRecycledEventArgs> ItemRecycled { get; set; }
Property Value
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
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
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
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[] |
|
Declaration
public string ScrollbarBackground { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Declaration
public ScrollbarStyle ScrollbarStyle { get; set; }
Property Value
SelectedBackground
Declaration
public string SelectedBackground { get; set; }
Property Value
| Type |
Description |
| System.String |
|
SelectedItems
Declaration
public IgbListPanelSelectedItemsCollection SelectedItems { get; protected set; }
Property Value
SelectedItemsChanged
Declaration
public Action<IgbListPanelSelectedItemsChangedEventArgs> SelectedItemsChanged { get; set; }
Property Value
SelectedItemsChangedScript
Declaration
public string SelectedItemsChangedScript { get; set; }
Property Value
| Type |
Description |
| System.String |
|
SelectedKeys
Declaration
public IgbListPanelSelectedKeysCollection SelectedKeys { get; protected set; }
Property Value
SelectedKeysChanged
Declaration
public Action<IgbListPanelSelectedKeysChangedEventArgs> SelectedKeysChanged { get; set; }
Property Value
SelectedKeysChangedScript
Declaration
public string SelectedKeysChangedScript { get; set; }
Property Value
| Type |
Description |
| System.String |
|
SelectionBehavior
Declaration
public ListPanelSelectionBehavior SelectionBehavior { get; set; }
Property Value
SelectionChanged
Declaration
public Action<IgbListPanelSelectionChangedEventArgs> SelectionChanged { get; set; }
Property Value
SelectionChangedScript
Declaration
public string SelectionChangedScript { get; set; }
Property Value
| Type |
Description |
| System.String |
|
SelectionMode
Declaration
public ListPanelSelectionMode SelectionMode { get; set; }
Property Value
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
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
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
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
GetCurrentSelectedItemsAsync()
Declaration
public Task<IgbListPanelSelectedItemsCollection> GetCurrentSelectedItemsAsync()
Returns
GetCurrentSelectedKeys()
Declaration
public IgbListPanelSelectedKeysCollection GetCurrentSelectedKeys()
Returns
GetCurrentSelectedKeysAsync()
Declaration
public Task<IgbListPanelSelectedKeysCollection> GetCurrentSelectedKeysAsync()
Returns
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
GetItemKeyAsync(String[], Object)
Declaration
public Task<IgbListPanelPrimaryKeyValue> GetItemKeyAsync(string[] primaryKey, object item_)
Parameters
| Type |
Name |
Description |
| System.String[] |
primaryKey |
|
| System.Object |
item_ |
|
Returns
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
GetRowKeyAsync(String[], Int32)
Declaration
public Task<IgbListPanelPrimaryKeyValue> GetRowKeyAsync(string[] primaryKey, int rowIndex)
Parameters
| Type |
Name |
Description |
| System.String[] |
primaryKey |
|
| System.Int32 |
rowIndex |
|
Returns
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 |
|
Declaration
public void ScrollToLastRowByIndex(double rowNumber)
Parameters
| Type |
Name |
Description |
| System.Double |
rowNumber |
|
Declaration
public Task ScrollToLastRowByIndexAsync(double rowNumber)
Parameters
| Type |
Name |
Description |
| System.Double |
rowNumber |
|
Returns
| Type |
Description |
| System.Threading.Tasks.Task |
|
Declaration
public void ScrollToRowByIndex(double rowNumber)
Parameters
| Type |
Name |
Description |
| System.Double |
rowNumber |
|
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
System.IDisposable