Class GridForeignColumn<TValue>

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
SfBaseComponent
SfDataBoundComponent
GridColumn
GridForeignColumn<TValue>
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Grids
Assembly: Syncfusion.Blazor.dll
Syntax
public class GridForeignColumn<TValue> : GridColumn, IComponent, IHandleEvent, IHandleAfterRender, IDisposable, IGridColumn
Type Parameters
Name
TValue

Constructors

GridForeignColumn()

Declaration
public GridForeignColumn()

Properties

ForeignDataSource

Defines the column data source which will act as foreign data source.

Declaration
[Parameter]
[JsonIgnore]
[JsonPropertyName("foreignDataSource")]
public IEnumerable<TValue> ForeignDataSource { get; set; }
Property Value
Type
IEnumerable<TValue>
Remarks

List or any IEnumerable type value is accepted as foreign data source. For custom binding or using remote service as foreign data source use GridForeignColumn<TValue> component and configure data source using SfDataManager.

Methods

BuildRenderTree(RenderTreeBuilder)

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

GetData(DataManagerRequest)

Performs data operation in the foreign key column based on the given query and returns data.

Declaration
public override Task<object> GetData(DataManagerRequest dataManagerRequest)
Parameters
Type Name Description
DataManagerRequest dataManagerRequest

Query value to be used for data fetching.
Returns
Type Description
Task<object>

object.
Overrides

GetForeignData()

Get Foreign Data

Declaration
public override object GetForeignData()
Returns
Type
object
Overrides

IsForeignColumn()

Returns true if the column is foreign key column.

Declaration
public override bool IsForeignColumn()
Returns
Type Description
bool

bool.
Overrides

OnAfterRenderAsync(bool)

Method invoked after each time the component has been rendered.

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

Set to true for the first time component rendering; otherwise gets false.
Returns
Type Description
Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

OnInitialized()

Declaration
protected override void OnInitialized()
Overrides

OnParametersSet()

Declaration
protected override void OnParametersSet()
Overrides

Implements