Inheritance

object
Implements
  • IComponent
  • IHandleEvent
  • IHandleAfterRender
  • JsonSerializable
  • IDisposable

constructor

public IgbListPanel()

Returns IgbListPanel

Inherited from: BaseRendererControl

[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public string Height { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public string Width { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public string Class { get; set; }

Inherited from: BaseRendererControl

[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }

Inherited from: BaseRendererControl

protected virtual string ParentTypeName { get; }

Inherited from: BaseRendererControl

Gets or sets how events are bubbled up from JavaScript to Blazor.

[Parameter]
public ControlEventBehavior EventBehavior { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public RenderFragment ChildContent { get; set; }

Inherited from: BaseRendererControl

Gets or sets what type of date conversion to make when round tripping dates.

[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }

Inherited from: BaseRendererControl

protected virtual bool SupportsVisualChildren { get; }

Inherited from: BaseRendererControl

protected virtual bool UseDirectRender { get; }

Inherited from: BaseRendererControl

protected virtual string DirectRenderElementName { get; }

Inherited from: BaseRendererControl

protected virtual bool NeedsDynamicContent { get; }

Inherited from: BaseRendererControl

protected virtual bool UseCamelEnumValues { get; }

Gets or sets the activation border color to use.

[Parameter]
public string ActivationBorder { get; set; }

Gets or sets the amount of bottom activation border to use for the cell content of this column.

[Parameter]
public int ActivationBorderBottomWidth { get; set; }

Gets or sets the amount of left activation border to use for the cell content for this column.

[Parameter]
public int ActivationBorderLeftWidth { get; set; }

Gets or sets the amount of right activation border to use for the cell content of this column.

[Parameter]
public int ActivationBorderRightWidth { get; set; }

Gets or sets the amount of top activation border to use for the cell content for this column.

[Parameter]
public int ActivationBorderTopWidth { get; set; }

Sets or gets the grid selection mode.

[Parameter]
public ListPanelActivationMode ActivationMode { get; set; }

Gets or sets the position of the active row.

[Parameter]
public int ActiveRow { get; set; }
[Parameter]
public Action<IgbListPanelActiveRowChangedEventArgs> ActiveRowChanged { get; set; }
[Parameter]
public string ActiveRowChangedScript { get; set; }

Gets either the inferred primary key from the data source, or the user provided primary key, if present. Represents the actual primary key that the grid will use in operations that require it.

[Parameter]
public string[] ActualPrimaryKey { get; set; }
[Parameter]
public double ActualRowHeight { get; set; }

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

[Parameter]
public string BackgroundColor { get; set; }
[Parameter]
public string CellFontFamily { get; set; }
[Parameter]
public double CellFontSize { get; set; }
[Parameter]
public string CellFontStyle { get; set; }
[Parameter]
public string CellFontWeight { get; set; }
[Parameter]
public Action<IgbListPanelContentRefreshedEventArgs> ContentRefreshed { get; set; }
[Parameter]
public string ContentRefreshedScript { get; set; }

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.

[Parameter]
public object DataSource { get; set; }

Provides a means of setting DataSource in the JavaScript environment.

[Parameter]
public string DataSourceScript { get; set; }

Gets the components default event behavior.

protected override ControlEventBehavior DefaultEventBehavior { get; }

Gets or sets whether the active row style will be applied to rows when made active.

[Parameter]
public bool IsActiveRowStyleEnabled { get; set; }

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

[Parameter]
public bool IsCustomRowHeightEnabled { get; set; }
[Parameter]
public Action<IgbListPanelContentRebindEventArgs> ItemRebind { get; set; }
[Parameter]
public string ItemRebindScript { get; set; }
[Parameter]
public Action<IgbListPanelContentRecycledEventArgs> ItemRecycled { get; set; }
[Parameter]
public string ItemRecycledScript { get; set; }

Gets or sets the spacing between items.

[Parameter]
public double ItemSpacing { get; set; }

Gets or sets the background color to use.

[Parameter]
public string NormalBackground { get; set; }

Gets or sets if the grid should notify on programmatic selection changes as well as changes from the UI.

[Parameter]
public bool NotifyOnAllSelectionChanges { get; set; }

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

[Parameter]
public ListPanelOrientation Orientation { get; set; }

Sets or gets the user provided primary key to assume for the data. Certain functionality of the grid requires a way to uniquely identify items in order to work correctly. If a primary key cannot be inferred from the data source, you may need to provide one here.

[Parameter]
public string[] PrimaryKey { get; set; }

Gets or Sets the property name that contains the values.

[Parameter]
public int RowHeight { get; set; }

Gets either the filtered properties to include in the schema of the data source.

[Parameter]
public string[] SchemaIncludedProperties { get; set; }

Gets or sets the scrollbar background color.

[Parameter]
public string ScrollbarBackground { get; set; }

Gets or sets the style of scrollbar.

[Parameter]
public ScrollbarStyle ScrollbarStyle { get; set; }

Gets or sets the background color to use for the cells when they are selected

[Parameter]
public string SelectedBackground { get; set; }

Gets which items are currently selected in the grid. Collection can be updated to programatically select items.

public IgbListPanelSelectedItemsCollection SelectedItems { get; protected set; }
[Parameter]
public Action<IgbListPanelSelectedItemsChangedEventArgs> SelectedItemsChanged { get; set; }
[Parameter]
public string SelectedItemsChangedScript { get; set; }

Gets which primary key values are currently selected in the grid. Collection can be updated to programatically select items.

public IgbListPanelSelectedKeysCollection SelectedKeys { get; protected set; }
[Parameter]
public Action<IgbListPanelSelectedKeysChangedEventArgs> SelectedKeysChanged { get; set; }
[Parameter]
public string SelectedKeysChangedScript { get; set; }

Sets or gets how selection behaves in the grid.

[Parameter]
public ListPanelSelectionBehavior SelectionBehavior { get; set; }
[Parameter]
public Action<IgbListPanelSelectionChangedEventArgs> SelectionChanged { get; set; }
[Parameter]
public string SelectionChangedScript { get; set; }

Sets or gets the grid selection mode.

[Parameter]
public ListPanelSelectionMode SelectionMode { get; set; }

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

[Parameter]
public string TextColor { get; set; }
public override string Type { get; }

Inherited from: BaseRendererControl

protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache

Inherited from: BaseRendererControl

protected string _cachedSerializedContent

Inherited from: BaseRendererControl

Resolves the components event behavior if Auto is selected.

protected ControlEventBehavior ResolveEventBehavior()

Returns any

Inherited from: BaseRendererControl

protected virtual string ResolveDisplay()

Returns any

Inherited from: BaseRendererControl

protected string ToSpinal(string value)

Parameters

  • value: string

Returns any

Inherited from: BaseRendererControl

protected virtual string TransformSimpleKey(string key)

Parameters

  • key: string

Returns any

Inherited from: BaseRendererControl

protected virtual bool IsTransformedEnumValue(string key)

Parameters

  • key: string

Returns any

TransformPotentialEnumValue(string, object)

Section titled "TransformPotentialEnumValue(string, object)"

Inherited from: BaseRendererControl

protected virtual object TransformPotentialEnumValue(string key, object value)

Parameters

  • key: string
  • value: object

Returns any

Inherited from: BaseRendererControl

protected virtual SequenceInfo BuildSequenceInfo(int startSequence)

Parameters

  • startSequence: int

Returns any

Inherited from: BaseRendererControl

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

  • builder: RenderTreeBuilder

Returns any

Inherited from: BaseRendererControl

protected Type TemplateContentType(string templateId)

Parameters

  • templateId: string

Returns any

Inherited from: BaseRendererControl

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

  • firstRender: bool

Returns any

Inherited from: BaseRendererControl

public Task EnsureReady()

Returns any

Inherited from: BaseRendererControl

protected void MarkPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Inherited from: BaseRendererControl

protected bool IsPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Serialize(SerializationContext, string)

Section titled "Serialize(SerializationContext, string)"

Inherited from: BaseRendererControl

public void Serialize(SerializationContext context, string propertyName = null)

Parameters

  • context: SerializationContext
  • propertyName: string

Returns any

Inherited from: BaseRendererControl

public string Serialize()

Returns any

InvokeMethod(string, object[], string[], ElementReference[])

Section titled "InvokeMethod(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererControl

protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodSync(string, object[], string[], ElementReference[])

Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererControl

protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

Inherited from: BaseRendererControl

Prevents data change notifications from be propagated to the component.

public void SuspendNotifications(object dataSource)

Parameters

  • dataSource: object

Returns any

Inherited from: BaseRendererControl

Resumes data change notifications.

public void ResumeNotifications(object dataSource, bool notify = true)

Parameters

  • dataSource: object
  • notify: bool

Returns any

NotifyInsertItem(object, int, object)

Section titled "NotifyInsertItem(object, int, object)"

Inherited from: BaseRendererControl

public void NotifyInsertItem(object dataSource, int index, object refItem)

Parameters

  • dataSource: object
  • index: int
  • refItem: object

Returns any

NotifyRemoveItem(object, int, object)

Section titled "NotifyRemoveItem(object, int, object)"

Inherited from: BaseRendererControl

public void NotifyRemoveItem(object dataSource, int index, object oldItem)

Parameters

  • dataSource: object
  • index: int
  • oldItem: object

Returns any

Inherited from: BaseRendererControl

public void NotifyClearItems(object dataSource)

Parameters

  • dataSource: object

Returns any

NotifySetItem(object, int, object, object)

Section titled "NotifySetItem(object, int, object, object)"

Inherited from: BaseRendererControl

public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)

Parameters

  • dataSource: object
  • index: int
  • oldItem: object
  • newItem: object

Returns any

NotifyUpdateItem(object, int, object, bool)

Section titled "NotifyUpdateItem(object, int, object, bool)"

Inherited from: BaseRendererControl

public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)

Parameters

  • dataSource: object
  • index: int
  • refItem: object
  • syncDataOnly: bool

Returns any

Inherited from: BaseRendererControl

public void OnRefChanged(string refName, object refValue)

Parameters

  • refName: string
  • refValue: object

Returns any

Inherited from: BaseRendererControl

public void OnInvokeReturn(long invokeId, object returnValue)

Parameters

  • invokeId: long
  • returnValue: object

Returns any

Inherited from: BaseRendererControl

protected string Camelize(string value)

Parameters

  • value: string

Returns any

Inherited from: BaseRendererControl

protected string ToPascal(string value)

Parameters

  • value: string

Returns any

OnElementNameChanged(BaseRendererElement, string, string)

Section titled "OnElementNameChanged(BaseRendererElement, string, string)"

Inherited from: BaseRendererControl

protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)

Parameters

  • element: BaseRendererElement
  • oldName: string
  • newName: string

Returns any

Inherited from: BaseRendererControl

protected virtual void Dispose(bool disposing)

Parameters

  • disposing: bool

Returns any

SetResourceStringAsync(string, string, string)

Section titled "SetResourceStringAsync(string, string, string)"

Inherited from: BaseRendererControl

public Task<object> SetResourceStringAsync(string grouping, string id, string value)

Parameters

  • grouping: string
  • id: string
  • value: string

Returns any

SetResourceStringAsync(string, string)

Section titled "SetResourceStringAsync(string, string)"

Inherited from: BaseRendererControl

public Task<object> SetResourceStringAsync(string grouping, string json)

Parameters

  • grouping: string
  • json: string

Returns any

SetPropertyValue(object, PropertyInfo, JsonElement)

Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"

Inherited from: BaseRendererControl

protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)

Parameters

  • item: object
  • property: PropertyInfo
  • jsonElement: JsonElement

Returns any

SetPropertyValue(object, PropertyInfo, object)

Section titled "SetPropertyValue(object, PropertyInfo, object)"

Inherited from: BaseRendererControl

protected void SetPropertyValue(object item, PropertyInfo property, object value)

Parameters

  • item: object
  • property: PropertyInfo
  • value: object

Returns any

Inherited from: BaseRendererControl

public void Dispose()

Returns any

public int DataIndexOfItem(object item)

Parameters

  • item: object

Returns any

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

public Task<int> DataIndexOfItemAsync(object item)

Parameters

  • item: object

Returns any

public void DeselectAllRows()

Returns any

Deselects all currently selected rows.

public Task DeselectAllRowsAsync()

Returns any

protected override void EnsureModulesLoaded()

Returns any

public string ExportSerializedVisualData()

Returns any

public Task<string> ExportSerializedVisualDataAsync()

Returns any

public object ExportVisualData()

Returns any

public Task<object> ExportVisualDataAsync()

Returns any

public override object FindByName(string name)

Parameters

  • name: string

Returns any

public int GetCurrentActiveRow()

Returns any

public Task<int> GetCurrentActiveRowAsync()

Returns any

public string[] GetCurrentActualPrimaryKey()

Returns any

public Task<string[]> GetCurrentActualPrimaryKeyAsync()

Returns any

public IgbListPanelSelectedItemsCollection GetCurrentSelectedItems()

Returns any

public Task<IgbListPanelSelectedItemsCollection> GetCurrentSelectedItemsAsync()

Returns any

public IgbListPanelSelectedKeysCollection GetCurrentSelectedKeys()

Returns any

public Task<IgbListPanelSelectedKeysCollection> GetCurrentSelectedKeysAsync()

Returns any

public int GetFirstVisibleIndex()

Returns any

Gets the first visible index in the grid.

public Task<int> GetFirstVisibleIndexAsync()

Returns any

public IgbListPanelPrimaryKeyValue GetItemKey(string[] primaryKey, object item_)

Parameters

  • primaryKey: string[]
  • item_: object

Returns any

public Task<IgbListPanelPrimaryKeyValue> GetItemKeyAsync(string[] primaryKey, object item_)

Parameters

  • primaryKey: string[]
  • item_: object

Returns any

public int GetLastVisibleIndex()

Returns any

Gets the last visible index in the grid.

public Task<int> GetLastVisibleIndexAsync()

Returns any

public IgbListPanelPrimaryKeyValue GetRowKey(string[] primaryKey, int rowIndex)

Parameters

  • primaryKey: string[]
  • rowIndex: int

Returns any

public Task<IgbListPanelPrimaryKeyValue> GetRowKeyAsync(string[] primaryKey, int rowIndex)

Parameters

  • primaryKey: string[]
  • rowIndex: int

Returns any

public void InvalidateVisibleItems()

Returns any

Invalidates the bound data for the rows currently visible.

public Task InvalidateVisibleItemsAsync()

Returns any

public void ScrollToLastRowByIndex(double rowNumber)

Parameters

  • rowNumber: double

Returns any

ScrollToLastRowByIndexAsync(double)

Section titled "ScrollToLastRowByIndexAsync(double)"

Scrolls the grid so that a row is the last visible, by index.

public Task ScrollToLastRowByIndexAsync(double rowNumber)

Parameters

  • rowNumber: double

Returns any

public void ScrollToRowByIndex(double rowNumber)

Parameters

  • rowNumber: double

Returns any

Scrolls the grid to given row, by index

public Task ScrollToRowByIndexAsync(double rowNumber)

Parameters

  • rowNumber: double

Returns any

public void SelectAllRows()

Returns any

Selects all of the rows in the grid.

public Task SelectAllRowsAsync()

Returns any

[Parameter]
public EventCallback<string[]> ActualPrimaryKeyChanged { get; set; }
[Parameter]
public EventCallback<IgbListPanelItemEventArgs> ItemClicked { get; set; }
[Parameter]
public EventCallback<IgbListPanelTemplateHeightRequestedEventArgs> ItemHeightRequested { get; set; }
[Parameter]
public EventCallback<IgbListPanelTemplateWidthRequestedEventArgs> ItemWidthRequested { get; set; }
[Parameter]
public EventCallback<IgbListPanelTemplateItemUpdatingEventArgs> RowUpdating { get; set; }
[Parameter]
public string ActualPrimaryKeyChangedScript { get; set; }
[Parameter]
public string ItemClickedScript { get; set; }
[Parameter]
public string ItemHeightRequestedScript { get; set; }
[Parameter]
public string ItemWidthRequestedScript { get; set; }
[Parameter]
public string RowUpdatingScript { get; set; }