Skip to main content

TextColumn Members

A grid column used to display and edit text values.

Constructors

Name Description
TextColumn() Initializes a new instance of the TextColumn class.

Fields

Name Description
AffixColorProperty static Identifies the AffixColor bindable property. Inherited from AffixTextColumnBase.
AffixFontAttributesProperty static Identifies the AffixFontAttributes bindable property. Inherited from AffixTextColumnBase.
AffixFontFamilyProperty static Identifies the AffixFontFamily bindable property. Inherited from AffixTextColumnBase.
AffixFontSizeProperty static Identifies the AffixFontSize bindable property. Inherited from AffixTextColumnBase.
AffixIndentProperty static Identifies the AffixIndent bindable property. Inherited from AffixTextColumnBase.
AllowAutoFilterProperty static Identifies the AllowAutoFilter bindable property. Inherited from GridColumn.
AllowExportProperty static Identifies the AllowExport bindable property. Inherited from GridColumn.
AllowSortProperty static Identifies the AllowSort bindable property. Inherited from GridColumn.
AutoFilterConditionProperty static Identifies the AutoFilterCondition bindable property. Inherited from GridColumn.
AutoFilterValueProperty static Identifies the AutoFilterValue bindable property. Inherited from GridColumn.
BackgroundColorProperty static Identifies the BackgroundColor bindable property. Inherited from GridColumn.
BindingContextProperty static Bindable property for BindingContext. Inherited from BindableObject.
CaptionProperty static Identifies the Caption bindable property. Inherited from GridColumn.
ClearIconVisibilityProperty static Identifies the ClearIconVisibility bindable property. Inherited from TextColumnBase.
ColumnProperty static Identifies the Column bindable property. Inherited from GridColumn.
ColumnSpanProperty static Identifies the ColumnSpan bindable property. Inherited from GridColumn.
DisplayFormatProperty static Identifies the DisplayFormat bindable property. Inherited from GridColumn.
EditFormCaptionProperty static Identifies the EditFormCaption bindable property. Inherited from GridColumn.
EnableImmediatePostingProperty static Identifies the EnableImmediatePosting bindable property. Inherited from GridColumn.
ExportCellAppearanceProperty static Identifies the ExportCellAppearance bindable property. Inherited from GridColumn.
ExportColumnHeaderAppearanceProperty static Identifies the ExportColumnHeaderAppearance bindable property. Inherited from GridColumn.
ExportMaxWidthProperty static Identifies the ExportMaxWidth bindable property. Inherited from GridColumn.
ExportMinWidthProperty static Identifies the ExportMinWidth bindable property. Inherited from GridColumn.
ExportTotalSummaryAppearanceProperty static Identifies the ExportTotalSummaryAppearance bindable property. Inherited from GridColumn.
ExportWidthProperty static Identifies the ExportWidth bindable property. Inherited from GridColumn.
FieldNameProperty static Identifies the FieldName bindable property. Inherited from GridColumn.
FilterModeProperty static Identifies the FilterMode bindable property. Inherited from GridColumn.
FixedStyleProperty static Identifies the FixedStyle bindable property. Inherited from GridColumn.
FontAttributesProperty static Identifies the FontAttributes bindable property. Inherited from TextColumnBase.
FontColorProperty static Identifies the FontColor bindable property. Inherited from TextColumnBase.
FontFamilyProperty static Identifies the FontFamily bindable property. Inherited from TextColumnBase.
FontSizeProperty static Identifies the FontSize bindable property. Inherited from TextColumnBase.
GroupCaptionDisplayFormatProperty static Identifies the GroupCaptionDisplayFormat bindable property. Inherited from GridColumn.
GroupCaptionTemplateProperty static Identifies the GroupCaptionTemplate bindable property. Inherited from GridColumn.
GroupIntervalProperty static Identifies the GroupInterval bindable property. Inherited from GridColumn.
HeaderBackgroundColorProperty static Identifies the HeaderBackgroundColor bindable property. Inherited from GridColumn.
HeaderBorderColorProperty static Identifies the HeaderBorderColor bindable property. Inherited from GridColumn.
HeaderBottomBorderColorProperty static Identifies the HeaderBottomBorderColor bindable property. Inherited from GridColumn.
HeaderCaptionLineBreakModeProperty static Identifies the HeaderCaptionLineBreakMode bindable property. Inherited from GridColumn.
HeaderContentTemplateProperty static Identifies the HeaderContentTemplate bindable property. Inherited from GridColumn.
HeaderFontAttributesProperty static Identifies the HeaderFontAttributes bindable property. Inherited from GridColumn.
HeaderFontColorProperty static Identifies the HeaderFontColor bindable property. Inherited from GridColumn.
HeaderFontFamilyProperty static Identifies the HeaderFontFamily bindable property. Inherited from GridColumn.
HeaderFontSizeProperty static Identifies the HeaderFontSize bindable property. Inherited from GridColumn.
HeaderPaddingProperty static Identifies the HeaderPadding bindable property. Inherited from GridColumn.
HeaderTextDecorationsProperty static Identifies the HeaderTextDecorations bindable property. Inherited from GridColumn.
HorizontalContentAlignmentProperty static Identifies the HorizontalContentAlignment bindable property. Inherited from GridColumn.
HorizontalHeaderAlignmentProperty static Identifies the HorizontalHeaderAlignment bindable property. Inherited from GridColumn.
ImmediateUpdateAutoFilterProperty static Identifies the ImmediateUpdateAutoFilter bindable property. Inherited from GridColumn.
IsGroupedProperty static Identifies the IsGrouped bindable property. Inherited from GridColumn.
IsReadOnlyProperty static Identifies the IsReadOnly bindable property. Inherited from GridColumn.
IsVisibleProperty static Identifies the IsVisible bindable property. Inherited from GridColumn.
KeyboardProperty static Identifies the Keyboard bindable property.
LineBreakModeProperty static Identifies the LineBreakMode bindable property. Inherited from TextColumnBase.
MaskPlaceholderCharProperty static Identifies the MaskPlaceholderChar bindable property.
MaskProperty static Identifies the Mask bindable property.
MaxWidthProperty static Identifies the MaxWidth bindable property. Inherited from GridColumn.
MinWidthProperty static Identifies the MinWidth bindable property. Inherited from GridColumn.
PaddingProperty static Identifies the Padding bindable property. Inherited from GridColumn.
PlaceholderTextProperty static Identifies the PlaceholderText bindable property. Inherited from TextColumnBase.
PrefixProperty static Identifies the Prefix bindable property. Inherited from AffixTextColumnBase.
RowProperty static Identifies the Row bindable property. Inherited from GridColumn.
RowSpanProperty static Identifies the RowSpan bindable property. Inherited from GridColumn.
ShowFilterIconProperty static Identifies the ShowFilterIcon bindable property. Inherited from GridColumn.
SortIndexProperty static Identifies the SortIndex bindable property. Inherited from GridColumn.
SortModeProperty static Identifies the SortMode bindable property. Inherited from GridColumn.
SortOrderProperty static Identifies the SortOrder bindable property. Inherited from GridColumn.
SuffixProperty static Identifies the Suffix bindable property. Inherited from AffixTextColumnBase.
TextDecorationsProperty static Identifies the TextDecorations bindable property. Inherited from TextColumnBase.
TotalSummaryTemplateProperty static Identifies the TotalSummaryTemplate bindable property. Inherited from GridColumn.
UnboundExpressionProperty static Identifies the UnboundExpression bindable property. Inherited from GridColumn.
UnboundTypeProperty static Identifies the UnboundType bindable property. Inherited from GridColumn.
VerticalContentAlignmentProperty static Identifies the VerticalContentAlignment bindable property. Inherited from GridColumn.
WidthProperty static Identifies the Width bindable property. Inherited from GridColumn.

Properties

Name Description
ActualAppearance Gets the common appearance settings that are applied to the current GridColumn. Inherited from GridColumn.
ActualCaption Gets the column caption as it is displayed in a column header. Inherited from GridColumn.
AffixColor Gets or sets the color of the text column’s affix. This is a bindable property. Inherited from AffixTextColumnBase.
AffixFontAttributes Gets or sets the affix’s font attributes. This is a bindable property. Inherited from AffixTextColumnBase.
AffixFontFamily Gets or sets the affix’s font family. This is a bindable property. Inherited from AffixTextColumnBase.
AffixFontSize Gets or sets the affix’s font size. This is a bindable property. Inherited from AffixTextColumnBase.
AffixIndent Gets or sets the affix’s indent. This is a bindable property. Inherited from AffixTextColumnBase.
AllowAutoFilter Gets or sets whether users can enter a value in the Auto Filter Row. This is a bindable property. Inherited from GridColumn.
AllowExport Gets or sets whether to display the column in the exported document. This is a bindable property. Inherited from GridColumn.
AllowSort Gets or sets whether end users can sort data by the column. This is a bindable property. Inherited from GridColumn.
AutoFilterCondition Gets or sets the filter condition (equals, contains, etc.) used to compare the value in the Auto-Filter Row with column values. This is a bindable property. Inherited from GridColumn.
AutoFilterValue Gets or sets the value of the cell in the Auto Filter Row. This is a bindable property. Inherited from GridColumn.
BackgroundColor Gets or sets the background color of the column’s cells. This is a bindable property. Inherited from GridColumn.
BindingContext

Gets or sets an object that contains the properties that will be targeted by the bound properties that belong to this BindableObject. This is a bindable property.

Inherited from BindableObject.
Caption Gets or sets the caption displayed in the column header. This is a bindable property. Inherited from GridColumn.
ClearIconVisibility Gets or sets when the clear icon is visible. This is a bindable property. Inherited from TextColumnBase.
Column Gets or sets the column of the grid’s multi-row layout (AdvancedColumnLayout) where cells are located. This is a bindable property. Inherited from GridColumn.
ColumnSpan Gets or sets the number of the columns that the column should be spanned across. This property is in effect only when the grid displays the multi-row layout (AdvancedColumnLayout). This is a bindable property. Inherited from GridColumn.
Dispatcher

Gets the dispatcher that was available when this bindable object was created, otherwise tries to find the nearest available dispatcher (probably the window’s/app’s).

Inherited from BindableObject.
DisplayFormat Gets or sets the pattern used to format cell values of the column. This is a bindable property. Inherited from GridColumn.
EditFormCaption Gets or sets the caption of the editor associated with the current column in the edit form. This is a bindable property. Inherited from GridColumn.
EnableImmediatePosting Gets or sets whether to post values to a data source immediately after changing the grid column’s cell value. This is a dependency property. Inherited from GridColumn.
ExportCellAppearance Gets or sets the appearance object applied to cells in an exported document. This is a bindable property. Inherited from GridColumn.
ExportColumnHeaderAppearance Gets or sets the appearance object applied to the column header items in an exported document. This is a bindable property. Inherited from GridColumn.
ExportMaxWidth Gets or sets the column’s maximum width in an exported document. This is a bindable property. Inherited from GridColumn.
ExportMinWidth Gets or sets the column’s minimum width in an exported document. This is a bindable property. Inherited from GridColumn.
ExportTotalSummaryAppearance Gets or sets the appearance object applied to total summary items when they are exported. This is a bindable property. Inherited from GridColumn.
ExportWidth Gets or sets the column’s width in an exported document. This is a bindable property. Inherited from GridColumn.
FieldName Gets or sets the name of the data source’s field associated with the grid column, or serves as an identifier for unbound columns. This is a bindable property. Inherited from GridColumn.
FilterMode Gets or sets whether filters are applied to the actual cell values or to the text displayed in cells. This is a bindable property. Inherited from GridColumn.
FixedStyle Gets or sets whether a column is fixed. This is a bindable property. Inherited from GridColumn.
FontAttributes Gets or sets whether the font in the column’s cells is bold or italic. This is a bindable property. Inherited from TextColumnBase.
FontColor Gets or sets the color for the text in the column’s cells. This is a bindable property. Inherited from TextColumnBase.
FontFamily Gets or sets the font name for the text in column’s cells. This is a bindable property. Inherited from TextColumnBase.
FontSize Gets or sets the font size for the text in column’s cells. This is a bindable property. Inherited from TextColumnBase.
GroupCaptionDisplayFormat Gets or sets the pattern used to construct group row captions. This is a bindable property. Inherited from GridColumn.
GroupCaptionTemplate Gets or sets the template that defines the visual representation of a group row caption. This is a bindable property. Inherited from GridColumn.
GroupInterval Gets or sets how data rows are combined into groups. This is a bindable property. Inherited from GridColumn.
HeaderBackgroundColor Gets or sets the background color of the grid column’s header. This is a bindable property. Inherited from GridColumn.
HeaderBorderColor Gets or sets the border color of the grid column’s header. This is a bindable property. Inherited from GridColumn.
HeaderBottomBorderColor Gets or sets the border color of the grid column header’s bottom border. This is a bindable property. Inherited from GridColumn.
HeaderCaptionLineBreakMode Gets or sets how to handle the caption text if it cannot fit on one line. This is a bindable property. Inherited from GridColumn.
HeaderContentTemplate Gets or sets the template that defines the visual representation of the column header. This is a bindable property. Inherited from GridColumn.
HeaderFontAttributes Gets or sets the grid column header’s font attributes. This is a bindable property. Inherited from GridColumn.
HeaderFontColor Gets or sets the grid column header’s font color. This is a bindable property. Inherited from GridColumn.
HeaderFontFamily Gets or sets the grid column header’s font family. This is a bindable property. Inherited from GridColumn.
HeaderFontSize Gets or sets the grid column header’s font size. This is a bindable property. Inherited from GridColumn.
HeaderPadding Gets or sets the grid column header’s padding. This is a bindable property. Inherited from GridColumn.
HeaderTextDecorations Gets or sets the grid column header’s text decorations. This is a bindable property. Inherited from GridColumn.
HorizontalContentAlignment Gets or sets the horizontal alignment of the column’s content. This is a bindable property. Inherited from GridColumn.
HorizontalHeaderAlignment Gets or sets the horizontal alignment of the column’s header. This is a bindable property. Inherited from GridColumn.
ImmediateUpdateAutoFilter Gets or sets whether to filter data each time a value in the Auto Filter Row is changed or only when a cell in the Auto Filter Row loses focus. This is a bindable property. Inherited from GridColumn.
IsGrouped Gets or sets whether grid data is grouped by the specified column. This is a bindable property. Inherited from GridColumn.
IsReadOnly Gets or sets whether users are allowed to change cell values in the column. This is a bindable property. Inherited from GridColumn.
IsUnbound Gets whether the column is unbound. Inherited from GridColumn.
IsVisible Gets or sets whether the column is visible in the grid. This is a bindable property. Inherited from GridColumn.
Keyboard Gets or sets the type of keyboard used to input text. This is a bindable property.
LineBreakMode Gets or sets how the grid handles text that cannot fit on one line within a cell. This is a bindable property. Inherited from TextColumnBase.
Mask Gets or sets a mask expression. This is a bindable property.
MaskPlaceholderChar Gets or sets the character used as a placeholder in the masked text column’s editor. This is a bindable property.
MaxWidth Gets or sets the column’s maximum width. This is a bindable property. Inherited from GridColumn.
MinWidth Gets or sets the column’s minimum width. This is a bindable property. Inherited from GridColumn.
Padding Gets or sets the distance between values and borders in the column’s cells. This is a bindable property. Inherited from GridColumn.
PlaceholderText Gets or sets an input prompt displayed in a cell when it is focused but does not contain a value. This is a bindable property. Inherited from TextColumnBase.
Prefix Gets or sets the text column’s prefix. This is a bindable property. Inherited from AffixTextColumnBase.
Row Gets or sets the row in which the column’s cells are located. This is a bindable property. Inherited from GridColumn.
RowSpan Allows you to stretch the column’s cells across multiple rows within the grid’s multi-row layout (AdvancedColumnLayout). Inherited from GridColumn.
ShowFilterIcon Gets or sets whether to show the filter icon in the Auto Filter Row’s cell. This is a bindable property. Inherited from GridColumn.
SortIndex Gets or sets the column’s position among sorted columns. This is a bindable property. Inherited from GridColumn.
SortMode Gets or sets whether the grid should sort or group data by column values or display text. This is a bindable property. Inherited from GridColumn.
SortOrder Gets or sets the column’s sort order. This is a bindable property. Inherited from GridColumn.
Suffix Gets or sets the text column’s suffix. This is a bindable property. Inherited from AffixTextColumnBase.
TextDecorations Gets or sets whether text of the column’s cells underlined and/or crossed out. This is a bindable property. Inherited from TextColumnBase.
TotalSummaryTemplate Gets or sets the template that defines the visual representation of the column’s total summary. This is a bindable property. Inherited from GridColumn.
UnboundExpression Gets or sets an expression used to calculate values for the unbound column. This is a bindable property. Inherited from GridColumn.
UnboundType Gets or sets whether the column is unbound, and the type of data the unbound column stores. This is a bindable property. Inherited from GridColumn.
VerticalContentAlignment Gets or sets the vertical alignment of the column’s content. This is a bindable property. Inherited from GridColumn.
Width Gets or sets the column’s width. This is a bindable property. Inherited from GridColumn.

Methods

Name Description
ApplyBindings() protected Applies all the current bindings to BindingContext. Inherited from BindableObject.
ClearValue(BindableProperty) Clears any value that is previously set for a bindable property. Inherited from BindableObject.
ClearValue(BindablePropertyKey) Clears any value that is previously set for a bindable property, identified by its key. Inherited from BindableObject.
CoerceValue(BindableProperty)

Coerces the value of the specified bindable property. This is done by invoking BindableProperty.CoerceValueDelegate of the specified bindable property.

Inherited from BindableObject.
CoerceValue(BindablePropertyKey)

Coerces the value of the specified bindable property. This is done by invoking BindableProperty.CoerceValueDelegate of the specified bindable property.

Inherited from BindableObject.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
GetValue(BindableProperty) Returns the value that is contained in the given bindable property. Inherited from BindableObject.
IsSet(BindableProperty) Determines whether or not a bindable property exists and has a value set. Inherited from BindableObject.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OnBindingContextChanged() protected Raises the BindingContextChanged event. Inherited from BindableObject.
OnPropertyChanged(String) protected Raises the PropertyChanged event. Inherited from BindableObject.
OnPropertyChanging(String) protected Raises the PropertyChanging event. Inherited from BindableObject.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RemoveBinding(BindableProperty) Removes a previously set binding from a bindable property. Inherited from BindableObject.
SetBinding(BindableProperty, BindingBase) Assigns a binding to a bindable property. Inherited from BindableObject.
SetInheritedBindingContext(BindableObject, Object) static Sets the inherited context to a nested element. Inherited from BindableObject.
SetValue(BindableProperty, Object) Sets the value of the specified bindable property. Inherited from BindableObject.
SetValue(BindablePropertyKey, Object) Sets the value of the specified bindable property. Inherited from BindableObject.
SetValueCore(BindableProperty, Object, SetValueFlags) For internal use by the Microsoft.Maui.Controls platform. Inherited from BindableObject.
ToString() Returns a string that represents the current object. Inherited from Object.
UnapplyBindings() protected Removes all current bindings from the current context. Inherited from BindableObject.

Events

Name Description
BindingContextChanged Occurs when the value of the BindingContext property changes. Inherited from BindableObject.
PropertyChanged Occurs when a property value changes. Inherited from BindableObject.
PropertyChanging Occurs when a property value is changing. Inherited from BindableObject.
See Also