Class IgbFieldType

Describes a field that can be used in the Grid and QueryBuilder components.

Inheritance
System.Object
BaseRendererElement
IgbFieldType
Implements
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbFieldType : BaseRendererElement, JsonSerializable

Constructors

IgbFieldType()

Declaration
public IgbFieldType()

Properties

DataType

The data type of the field.

Declaration
public GridColumnDataType DataType { get; set; }
Property Value
Type Description
GridColumnDataType

DefaultDateTimeFormat

Default date/time format for Date/Time fields.

Declaration
public string DefaultDateTimeFormat { get; set; }
Property Value
Type Description
System.String

DefaultTimeFormat

Default time format for Date/Time fields.

Declaration
public string DefaultTimeFormat { get; set; }
Property Value
Type Description
System.String

EditorOptions

Options for the editor associated with this field.

Declaration
public IgbFieldEditorOptions EditorOptions { get; set; }
Property Value
Type Description
IgbFieldEditorOptions

Field

The internal field name, used in expressions and queries.

Declaration
public string Field { get; set; }
Property Value
Type Description
System.String

Filters

Optional filtering operands that apply to this field.

Declaration
public IgbFilteringOperand Filters { get; set; }
Property Value
Type Description
IgbFilteringOperand

Header

Optional column header for UI display purposes.

Declaration
public string Header { get; set; }
Property Value
Type Description
System.String

Label

Display label for the field.

Declaration
public string Label { get; set; }
Property Value
Type Description
System.String

PipeArgs

Optional arguments for any pipe applied to the field.

Declaration
public IgbFieldPipeArgs PipeArgs { get; set; }
Property Value
Type Description
IgbFieldPipeArgs

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

Methods

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

Formatter(Object, Object)

Declaration
public object Formatter(object value, object rowData)
Parameters
Type Name Description
System.Object value
System.Object rowData
Returns
Type Description
System.Object

FormatterAsync(Object, Object)

Declaration
public Task<object> FormatterAsync(object value, object rowData)
Parameters
Type Name Description
System.Object value
System.Object rowData
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

Implements