Class DataGridTextColumn

Namespace

Myra.Graphics2D.UI.Data

Assembly

Myra.dll

A DataGrid column that displays text values, inheriting configuration from DataGridColumnBase.

public class DataGridTextColumn : DataGridColumnBase

Inheritance

object

DataGridColumnBase

DataGridTextColumn

Inherited Members

DataGridColumnBase.Property

DataGridColumnBase.Header

DataGridColumnBase.Width

DataGridColumnBase.HasSorting

DataGridColumnBase.HasFilter

DataGridColumnBase.HeaderHorizontalAlignment

DataGridColumnBase.CellHorizontalAlignment

DataGridColumnBase.Filter

DataGridColumnBase.FilterStringComparison

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DataGridTextColumn()

Initializes a new instance of the DataGridTextColumn class with default values.

public DataGridTextColumn()

DataGridTextColumn(string, int, string)

Initializes a new instance of the DataGridTextColumn class with the specified property and width, using the property name as the header text.

public DataGridTextColumn(string property, int width = 100, string format = null)

Parameters

property string

The name of the property on the data object to bind to.

width int

The width of the column in pixels.

format string

An optional format string applied to the value (e.g. "{0:C2}").

DataGridTextColumn(string, string, int, string)

Initializes a new instance of the DataGridTextColumn class with the specified property, header, and width.

public DataGridTextColumn(string property, string header, int width = 100, string format = null)

Parameters

property string

The name of the property on the data object to bind to.

header string

The text displayed in the column header.

width int

The width of the column in pixels.

format string

An optional format string applied to the value (e.g. "{0:C2}").

Properties

Flags

Gets the DataGridColumnFlags describing which capabilities this column type supports.

public override DataGridColumnFlags Flags { get; }

Property Value

DataGridColumnFlags

Format

Gets or sets the format string applied to the cell value before display (e.g. "{0:C2}"). When null or empty, the value's ToString result is used directly.

public string Format { get; set; }

Property Value

string

Methods

CreateWidget(object, DataGridStyle)

Creates the widget used to display the cell value. The DataGridStyle is provided so the column can apply the appropriate cell style.

public override Widget CreateWidget(object value, DataGridStyle style)

Parameters

value object

The bound property value of the cell.

style DataGridStyle

The active DataGrid style.

Returns

Widget

The widget to display, or null for an empty cell.