Class GroupGridBinder

Namespace

Tripous.Desktop

Assembly

Tripous.Desktop.dll

Provides helper methods for binding group grids to data tables and definitions.

public static class GroupGridBinder

Inheritance

object

GroupGridBinder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

BindGrid(GroupGrid, DataView, bool)

Binds a group grid to a data view.

public static List<GroupGridColumn> BindGrid(GroupGrid Grid, DataView DataView, bool GoToFirst = true)

Parameters

Grid GroupGrid

The group grid.

DataView DataView

The data view.

GoToFirst bool

True to select the first row.

Returns

List<GroupGridColumn>

The created group grid columns.

BindGrid(SelectDef, GroupGrid, DataView, bool)

Binds a group grid to a data view using select definition metadata.

public static List<GroupGridColumn> BindGrid(SelectDef SelectDef, GroupGrid Grid, DataView DataView, bool GoToFirst = true)

Parameters

SelectDef SelectDef

The select definition.

Grid GroupGrid

The group grid.

DataView DataView

The data view.

GoToFirst bool

True to select the first row.

Returns

List<GroupGridColumn>

The created group grid columns.

CreateColumns(GroupGrid, DataColumn[])

Creates group grid columns from data columns.

public static List<GroupGridColumn> CreateColumns(GroupGrid Grid, DataColumn[] DataColumns)

Parameters

Grid GroupGrid

The group grid.

DataColumns DataColumn[]

The data columns.

Returns

List<GroupGridColumn>

The created group grid columns.

CreateGridColumn(DataColumn, string, TextAlignment?, bool)

Creates a group grid column from a data column.

public static GroupGridColumn CreateGridColumn(DataColumn Column, string Format = null, TextAlignment? Alignment = null, bool IsReadOnly = false)

Parameters

Column DataColumn

The data column.

Format string

The display format.

Alignment TextAlignment?

The text alignment.

IsReadOnly bool

True when the column is read-only.

Returns

GroupGridColumn

The created group grid column.

CreateGridColumn(string, string, DataFieldType, string, bool)

Creates a group grid column.

public static GroupGridColumn CreateGridColumn(string ColumnName, string Header, DataFieldType DataType, string Format = null, bool IsReadOnly = false)

Parameters

ColumnName string

The column name.

Header string

The column header.

DataType DataFieldType

The data type.

Format string

The display format.

IsReadOnly bool

True when the column is read-only.

Returns

GroupGridColumn

The created group grid column.

CreateGridColumn(FieldDef)

Creates a group grid column from a field definition.

public static GroupGridColumn CreateGridColumn(FieldDef FieldDef)

Parameters

FieldDef FieldDef

The field definition.

Returns

GroupGridColumn

The created group grid column.

CreateLocatorColumn2(string, string, FieldDef, LocatorFieldDef, LocatorDef, LocatorMapPlan)

Creates a locator display column for a group grid.

public static GroupGridColumn CreateLocatorColumn2(string ColumnName, string Header, FieldDef FieldDef, LocatorFieldDef LocatorFieldDef, LocatorDef LocatorDef, LocatorMapPlan MapPlan)

Parameters

ColumnName string

The target display column name.

Header string

The column header.

FieldDef FieldDef

The reference field definition.

LocatorFieldDef LocatorFieldDef

The locator source field definition.

LocatorDef LocatorDef

The locator definition.

MapPlan LocatorMapPlan

The locator mapping plan.

Returns

GroupGridColumn

The created group grid column.

CreateLookupColumn(FieldDef, LookupDef)

Creates a lookup group grid column from a field definition.

public static GroupGridColumn CreateLookupColumn(FieldDef FieldDef, LookupDef LookupDef = null)

Parameters

FieldDef FieldDef

The field definition.

LookupDef LookupDef

The lookup definition.

Returns

GroupGridColumn

The created group grid column.

GetCurrentRowView(GroupGrid)

Returns the current row view of a group grid.

public static DataRowView GetCurrentRowView(GroupGrid Grid)

Parameters

Grid GroupGrid

The group grid.

Returns

DataRowView

The current row view, if any; otherwise, null.

GetInfo(GroupGridColumn)

Returns the group grid column binding associated with a group grid column.

public static GroupGridColumnBinding GetInfo(this GroupGridColumn Column)

Parameters

Column GroupGridColumn

The group grid column.

Returns

GroupGridColumnBinding

The group grid column binding, if any; otherwise, null.

GetInfoList(GroupGrid)

Returns the group grid column bindings associated with a group grid.

public static List<GroupGridColumnBinding> GetInfoList(this GroupGrid Grid)

Parameters

Grid GroupGrid

The group grid.

Returns

List<GroupGridColumnBinding>

The group grid column bindings.

SelectRow(GroupGrid, int)

Selects a row by adapter row index.

public static bool SelectRow(GroupGrid Grid, int RowIndex)

Parameters

Grid GroupGrid

The group grid.

RowIndex int

The adapter row index.

Returns

bool

True if the row was selected; otherwise, false.

UnBindGrid(GroupGrid)

Unbinds a group grid.

public static void UnBindGrid(GroupGrid Grid)

Parameters

Grid GroupGrid

The group grid.