QuickGrid<TGridItem> クラス

定義

名前空間:

Microsoft.AspNetCore.Components.QuickGrid

アセンブリ:

Microsoft.AspNetCore.Components.QuickGrid.dll

パッケージ:

Microsoft.AspNetCore.Components.QuickGrid v8.0.0

ソース:

QuickGrid.razor

グリッドを表示するコンポーネント。

[Microsoft.AspNetCore.Components.CascadingTypeParameter("TGridItem")]
public class QuickGrid<TGridItem> : Microsoft.AspNetCore.Components.ComponentBase, IAsyncDisposable

[<Microsoft.AspNetCore.Components.CascadingTypeParameter("TGridItem")>]
type QuickGrid<'GridItem> = class
    inherit ComponentBase
    interface IAsyncDisposable

Public Class QuickGrid(Of TGridItem)
Inherits ComponentBase
Implements IAsyncDisposable

型パラメーター

TGridItem

グリッド内の各行によって表されるデータの種類。

継承

Object

ComponentBase

QuickGrid<TGridItem>

属性

CascadingTypeParameterAttribute

実装

IAsyncDisposable

コンストラクター

QuickGrid<TGridItem>()

QuickGrid<TGridItem>のインスタンスを構築します。

プロパティ

AdditionalAttributes	作成された要素に適用される追加の属性のコレクションを取得または設定します。
Assets	アプリケーションの ResourceAssetCollection を取得します。 (継承元 ComponentBase)
AssignedRenderMode	このコンポーネントに割り当てられている IComponentRenderMode を取得します。 (継承元 ComponentBase)
ChildContent	このインスタンスの子コンポーネントを定義します。 たとえば、ColumnBase<TGridItem> 基底クラスから派生したコンポーネントを追加して列を定義できます。
Class	オプションの CSS クラス名。 指定した場合、これはレンダリングされたテーブルのクラス属性に含まれます。
ItemKey	必要に応じて、レンダリングされた各行の @key の値を定義します。 通常、これは、データ項目ごとに主キー値などの一意の識別子を指定するために使用する必要があります。 これにより、TGridItem インスタンスが新しいコピーに置き換えられた場合 (たとえば、基になるデータ ストアに対する新しいクエリの後など) でも、行要素とデータ項目の間の関連付けを一意の識別子に基づいて保持できます。 設定されていない場合、@key は TGridItem インスタンス自体になります。
Items	グリッドのクエリ可能なデータ ソース。 これは、AsQueryable(IEnumerable) 拡張メソッド、EntityFramework DataSet、またはそこから派生した IQueryable を使用して、メモリ内データをクエリ可能に変換できます。 Items または ItemsProviderを指定する必要がありますが、両方は指定しないでください。
ItemSize	これは、Virtualizeを使用する場合にのみ適用されます。 各行の予想される高さをピクセル単位で定義します。これにより、仮想化メカニズムは、表示サイズに合わせて正しい数の項目をフェッチし、正確なスクロールを確保できます。
ItemsProvider	グリッドのデータを提供するコールバック。 Items または ItemsProviderを指定する必要がありますが、両方は指定しないでください。
Pagination	必要に応じて、この QuickGrid<TGridItem> インスタンスを PaginationState モデルにリンクすることで、グリッドは現在のデータ ページのみをフェッチしてレンダリングします。 これは通常、Paginator コンポーネントや、指定された PaginationState インスタンスを表示および更新するその他の UI ロジックと組み合わせて使用されます。
RendererInfo	コンポーネントが実行されている RendererInfo を取得します。 (継承元 ComponentBase)
Theme	テーマ名。既定値は "default" です。 これは、テーブルに一致するスタイルルールに影響します。
Virtualize	true の場合、グリッドは仮想化でレンダリングされます。 通常、これはスクロールと組み合わせて使用され、グリッドは現在のスクロール ビューポートの周りのデータのみをフェッチしてレンダリングします。 これにより、大規模なデータ セットをスクロールするときのパフォーマンスが大幅に向上します。 Virtualizeを使用する場合は、ItemSize の値を指定し、すべての行が同じ高さでレンダリングされるようにする必要があります。 一般に、レンダリングされるデータの量が少ない場合、または改ページ位置を使用している場合は、Virtualize を使用しないことをお勧めしています。

メソッド

BuildRenderTree(RenderTreeBuilder)	グリッドを表示するコンポーネント。
DispatchExceptionAsync(Exception)	指定された exception を、このコンポーネントによってスローされるものとして扱います。 これにより、外側の ErrorBoundary が失敗状態に遷移します。 外側の ErrorBoundary がない場合は、外側のレンダラーからの例外と見なされます。 これは、コンポーネント ライフサイクル メソッドの外部で例外が発生したが、コンポーネント ライフサイクル メソッドからの例外と同じように処理する場合に便利です。 (継承元 ComponentBase)
DisposeAsync()	グリッドを表示するコンポーネント。
InvokeAsync(Action)	関連付けられたレンダラーの同期コンテキストで、指定された作業項目を実行します。 (継承元 ComponentBase)
InvokeAsync(Func<Task>)	関連付けられたレンダラーの同期コンテキストで、指定された作業項目を実行します。 (継承元 ComponentBase)
OnAfterRender(Boolean)	コンポーネントが対話形式でレンダリングされ、UI の更新が完了するたびに呼び出されるメソッド (たとえば、ブラウザー DOM に要素が追加された後)。 ElementReference フィールドは、この実行時までに設定されます。 これらのプロセスはライブ ブラウザー DOM にアタッチされておらず、DOM が更新される前に既に完了しているため、プリレンダリング中またはサーバー側のレンダリング中にこのメソッドは呼び出されません。 (継承元 ComponentBase)
OnAfterRenderAsync(Boolean)	コンポーネントが対話形式でレンダリングされ、UI の更新が完了するたびに呼び出されるメソッド (たとえば、要素がブラウザー DOM に追加された後)。 ElementReference フィールドは、この実行時までに設定されます。 これらのプロセスはライブ ブラウザー DOM にアタッチされておらず、DOM が更新される前に既に完了しているため、プリレンダリング中またはサーバー側のレンダリング中にこのメソッドは呼び出されません。 返された Taskが完了すると、無限のレンダリング ループが発生するため、コンポーネントは自動的に再レンダリングされないことに注意してください。
OnInitialized()	コンポーネントを起動する準備ができたときに呼び出されるメソッド。レンダー ツリー内の親から初期パラメーターを受け取りました。 (継承元 ComponentBase)
OnInitializedAsync()	コンポーネントを起動する準備ができたときに呼び出されるメソッド。レンダー ツリー内の親から初期パラメーターを受け取りました。 非同期操作を実行し、その操作が完了したときにコンポーネントを更新する場合は、このメソッドをオーバーライドします。 (継承元 ComponentBase)
OnParametersSet()	コンポーネントがレンダー ツリー内の親からパラメーターを受け取り、受信値がプロパティに割り当てられているときに呼び出されるメソッド。 (継承元 ComponentBase)
OnParametersSetAsync()	コンポーネントがレンダー ツリー内の親からパラメーターを受け取り、受信値がプロパティに割り当てられているときに呼び出されるメソッド。
RefreshDataAsync()	指定されたデータ ソース (Items または ItemsProvider) から現在のデータを再フェッチしてレンダリングするようにグリッドに指示します。
SetParametersAsync(ParameterView)	レンダー ツリー内のコンポーネントの親によって提供されるパラメーターを設定します。 (継承元 ComponentBase)
ShouldRender()	コンポーネントをレンダリングするかどうかを示すフラグを返します。 (継承元 ComponentBase)
ShowColumnOptionsAsync(ColumnBase<TGridItem>)	指定した列の ColumnOptions UI を表示し、以前に表示されていたその他の列オプション UI を閉じます。
SortByColumnAsync(ColumnBase<TGridItem>, SortDirection)	グリッドの現在の並べ替え列を、指定した columnに設定します。
StateHasChanged()	状態が変更されたことをコンポーネントに通知します。 該当する場合は、コンポーネントが再レンダリングされます。 (継承元 ComponentBase)

明示的なインターフェイスの実装

IComponent.Attach(RenderHandle)	グリッドを表示するコンポーネント。 (継承元 ComponentBase)
IHandleAfterRender.OnAfterRenderAsync()	グリッドを表示するコンポーネント。 (継承元 ComponentBase)
IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object)	グリッドを表示するコンポーネント。 (継承元 ComponentBase)