Version 20.1 (latest)

XamDataGrid Class Properties

For a list of all members of this type, see XamDataGrid members.

Public Properties
 NameDescription
Public PropertyActivationModeSets or gets the grid selection mode.  
Public PropertyActiveCellGets or sets the position of the active cell.  
Public PropertyActualDataSourceGets the actual data source that is being used by the grid. If a collection was provided for the grid data, an implicit LocalDataSource has been created, and this is available via this property.  
Public PropertyActualPrimaryKeyGets either the inferred primary key from the data source, or the user provided primary key, if present. Represents the actual primary key that the grid will use in operations that require it.  
Public PropertyActualVisibleRegionGets the region of the grid that is visible.  
Public PropertyAnchorX (Inherited from Xamarin.Forms.VisualElement)
Public PropertyAnchorY (Inherited from Xamarin.Forms.VisualElement)
Public PropertyAnimationSettingsSets or gets the default animation settings for the grid.  
Public PropertyAutoGenerateColumnsConfigures whether or not the grid will autogenerate columns when the data source is set.  
Public PropertyAutomationId (Inherited from Xamarin.Forms.Element)
Public PropertyBackgroundColor (Inherited from Xamarin.Forms.VisualElement)
Public PropertyBehaviors (Inherited from Xamarin.Forms.VisualElement)
Public PropertyBindingContext (Inherited from Xamarin.Forms.BindableObject)
Public PropertyBounds (Inherited from Xamarin.Forms.VisualElement)
Public PropertyCellBackgroundGets or sets the default background color to use for content cells  
Public PropertyCellDataLoadedAnimationModeSets or gets the cell data loaded animation mode to use.  
Public PropertyCellFontAttributesReturns or sets the font style for the text.  
Public PropertyCellFontFamilyReturns or sets the font family for the text.  
Public PropertyCellFontSizeReturns or sets the font size for the text.  
Public PropertyCellSelectedBackgroundGets or sets the default background color to use for content cells when a row is in a selected state  
Public PropertyCellSelectionAnimationModeSets or gets the cell selection animation mode to use.  
Public PropertyCellTextColorGets or sets the default text color to use for content cells  
Public Propertyclass (Inherited from Xamarin.Forms.NavigableElement)
Public PropertyClassId (Inherited from Xamarin.Forms.Element)
Public PropertyColumnAddingAnimationModeSets or gets the Column Adding Animation mode to use.  
Public PropertyColumnAnimationSettingsSets or gets the default column animation settings for all columns.  
Public PropertyColumnExchangingAnimationModeSets or gets the column exchanging animation mode to use.  
Public PropertyColumnHidingAnimationModeSets or gets the column hiding animation mode to use.  
Public PropertyColumnMovingAnimationModeSets or gets the column moving animation mode to use.  
Public PropertyColumnPropertyUpdatingAnimationModeSets or gets the Column Property Updating Animation mode to use.  
Public PropertyColumnsGets the column definitions that are assigned to the grid. This collection can be modified to add or remove columns in the grid.  
Public PropertyColumnShowingAnimationModeSets or gets the column showing animation mode to use.  
Public PropertyDataSourceDesiredPropertiesGets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source.  
Public PropertyDefaultColumnMinWidthGets or sets the default minimum width to use on all columns. Ignored if NaN.  
Public PropertyDefaultColumnWidthGets or sets the default width to use on all columns.  
Public PropertyDispatcher (Inherited from Xamarin.Forms.BindableObject)
Public PropertyEffects (Inherited from Xamarin.Forms.Element)
Public PropertyFilterExpressionsGets the current filter that is applied to the grid. Collection can be updated to modify the filter for the grid. Once filter expresisons are in this collection, the grid will no longer listen for changes on their properties.  
Public PropertyFlowDirection (Inherited from Xamarin.Forms.VisualElement)
Public PropertyGestureRecognizers (Inherited from Xamarin.Forms.View)
Public PropertyGroupDescriptionsGets the current grouping that is applied to the grid. Collection can be updated to modify the grouping for the grid. Once grouping descriptions are in this collection, the grid will no longer listen for changes on their properties.  
Public PropertyGroupHeaderDisplayModeGets or sets how group headers are displayed when there are multiple groups defined in the grid.  
Public PropertyGroupSummaryDisplayModeGets or sets the display mode summaries will use inside groups.  
Public PropertyHeaderBackgroundGets or sets the default background color to use for header cells  
Public PropertyHeaderClickActionReturns/sets the action to take when a column header is clicked.  
Public PropertyHeaderFontAttributesReturns or sets the font style for the text.  
Public PropertyHeaderFontFamilyReturns or sets the font family for the text.  
Public PropertyHeaderFontSizeReturns or sets the font size for the text.  
Public PropertyHeaderHeightGets or sets the height to use for the header row.  
Public PropertyHeaderSeparatorGets or sets the header seperator settings.  
Public PropertyHeaderSeparatorBackgroundGets or sets the default background color to use for header separators.  
Public PropertyHeaderSeparatorWidthGets or sets the width of the header separators.  
Public PropertyHeaderSortIndicatorColorGets or sets the default text color to use for content cells  
Public PropertyHeaderSortIndicatorStyleGets or sets the default render style for sort indicators in header cells.  
Public PropertyHeaderTextColorGets or sets the default text color to use for header cells  
Public PropertyHeight (Inherited from Xamarin.Forms.VisualElement)
Public PropertyHeightRequest (Inherited from Xamarin.Forms.VisualElement)
Public PropertyHorizontalOptions (Inherited from Xamarin.Forms.View)
Public PropertyId (Inherited from Xamarin.Forms.Element)
Public PropertyInputTransparent (Inherited from Xamarin.Forms.VisualElement)
Public PropertyInsetRepresents how much the content is inset within the scroller.  
Public PropertyIsEnabled (Inherited from Xamarin.Forms.VisualElement)
Public PropertyIsFilterUIEnabledGets or sets whether to show the filtering UI in the headers for columns where filtering is enabled.  
Public PropertyIsFocused (Inherited from Xamarin.Forms.VisualElement)
Public PropertyIsGroupExpandedDefaultGets or sets whether groups are expanded or collapsed by default.  
Public PropertyIsGroupRowStickyGets or sets if group rows will stick to the top of the grid.  
Public PropertyIsHeaderSeparatorVisibleGets or sets if header separators are rendered.  
Public PropertyIsPlaceholderRenderingEnabledConfigures whether or not place holders are used for cells who do not have their data yet.  
Public PropertyIsTabStop (Inherited from Xamarin.Forms.VisualElement)
Public PropertyIsVisible (Inherited from Xamarin.Forms.VisualElement)
Public PropertyItemsSourceGets or sets the data to which to bind the grid. This can be some type of array or list, or it can be an IDataSource instance.  
Public PropertyLastStickyRowBackgroundGets or sets the default color to use for the last sticky row  
Public PropertyMargin (Inherited from Xamarin.Forms.View)
Public PropertyMinimumHeightRequest (Inherited from Xamarin.Forms.VisualElement)
Public PropertyMinimumWidthRequest (Inherited from Xamarin.Forms.VisualElement)
Public PropertyNavigation (Inherited from Xamarin.Forms.NavigableElement)
Public PropertyOpacity (Inherited from Xamarin.Forms.VisualElement)
Public PropertyParent (Inherited from Xamarin.Forms.Element)
Public PropertyPinnedAreaSeparatorWidthGets or sets the width of the pinned area separators.  
Public PropertyPinnedItemsGets which items are currently pinned in the grid. Collection can be updated to programatically pin items.  
Public PropertyPinnedKeysGets which primary keys are currently pinned in the grid. Collection can be updated to programatically pin items.  
Public PropertyPinnedRowBackgroundGets or sets the default color to use for pinned rows  
Public PropertyPinnedRowOpacityGets or sets the default opacity to use for pinned rows  
Public PropertyPrimaryKeySets or gets the user provided primary key to assume for the data. Certain functionality of the grid requires a way to uniquely identify items in order to work correctly. If a primary key cannot be inferred from the data source, you may need to provide one here.  
Public PropertyReactsToFilterChangesSets or gets whether the grid will react to filter changes.  
Public PropertyReactsToGroupChangesSets or gets whether the grid will react to group changes.  
Public PropertyReactsToSortChangesSets or gets whether the grid will react to sort changes.  
Public PropertyResources (Inherited from Xamarin.Forms.VisualElement)
Public PropertyResponsiveStatesA set of states that can be applied to the columns of the grid based on available space.  
Public PropertyRotation (Inherited from Xamarin.Forms.VisualElement)
Public PropertyRotationX (Inherited from Xamarin.Forms.VisualElement)
Public PropertyRotationY (Inherited from Xamarin.Forms.VisualElement)
Public PropertyRowHeightGets or sets the height to use for the rows in the grid.  
Public PropertyRowSelectionAnimationModeSets or gets the row selection animation mode to use.  
Public PropertyRowSeparatorGets or sets the row seperator settings.  
Public PropertyRowSeparatorBackgroundGets or sets the default background color to use for row separators  
Public PropertyRowSeparatorHeightSets or gets the height to use for the row separators.  
Public PropertyRowSeparatorLastStickyRowBackgroundGets or sets the default last sticky row background color to use for row separators  
Public PropertyRowSeparatorPinnedRowBackgroundGets or sets the pinned row background color to use for row separators  
Public PropertyRowSeparatorStickyRowBackgroundGets or sets the default sticky row background color to use for row separators  
Public PropertyScale (Inherited from Xamarin.Forms.VisualElement)
Public PropertyScaleX (Inherited from Xamarin.Forms.VisualElement)
Public PropertyScaleY (Inherited from Xamarin.Forms.VisualElement)
Public PropertySectionHeaderGets or sets the header type used for sectioning off groups of rows.  
Public PropertySectionHeaderBackgroundGets or sets the default background color to use for section header cells  
Public PropertySectionHeaderFontAttributesReturns or sets the font style for the text.  
Public PropertySectionHeaderFontFamilyReturns or sets the font family for the text.  
Public PropertySectionHeaderFontSizeReturns or sets the font size for the text.  
Public PropertySectionHeaderSelectedBackgroundGets or sets the default background color to use for section header cells when a row is in a selected state  
Public PropertySectionHeaderTextColorGets or sets the default text color to use for section header cells  
Public PropertySelectedCellRangesGets which cell ranges are currently selected in the grid. Collection can be updated to programatically select cells.  
Public PropertySelectedCellsGets which cells are currently selected in the grid. Collection can be updated to programatically select cells.  
Public PropertySelectedItemsGets which items are currently selected in the grid. Collection can be updated to programatically select items.  
Public PropertySelectedKeysGets which primary key values are currently selected in the grid. Collection can be updated to programatically select items.  
Public PropertySelectionModeSets or gets the grid selection mode.  
Public PropertySortDescriptionsGets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties.  
Public PropertyStickyRowBackgroundGets or sets the default color to use for sticky rows  
Public PropertyStyle (Inherited from Xamarin.Forms.NavigableElement)
Public PropertyStyleClass (Inherited from Xamarin.Forms.NavigableElement)
Public PropertyStyleId (Inherited from Xamarin.Forms.Element)
Public PropertySummaryDescriptionsGets the current summaries that are applied to the grid.  
Public PropertySummaryFontAttributesReturns or sets the font style for the text.  
Public PropertySummaryFontFamilyReturns or sets the font family for the text.  
Public PropertySummaryFontSizeReturns or sets the font size for the text.  
Public PropertySummaryRootBackgroundGets or sets the default background color to use for summary cells at the root level.  
Public PropertySummaryRootNameTextColorGets or sets the default text color to use for summary names in summary cells at the root level.  
Public PropertySummaryRootSelectedBackgroundGets or sets the default background color to use for summary cells at the root level.  
Public PropertySummaryRootTextColorGets or sets the default text color to use for summary cells at the root level.  
Public PropertySummaryRowRootGets or sets the cell definition used for summary rows at the root level.  
Public PropertySummaryRowSectionGets or sets the cell definition used for summary rows at the section level.  
Public PropertySummaryScopeGets or sets the scope which summaries are calculated for.  
Public PropertySummarySectionBackgroundGets or sets the default background color to use for summary cells at the section level.  
Public PropertySummarySectionFontAttributesReturns or sets the font style for the text.  
Public PropertySummarySectionFontFamilyReturns or sets the font family for the text.  
Public PropertySummarySectionFontSizeReturns or sets the font size for the text.  
Public PropertySummarySectionNameTextColorGets or sets the default text color to use for summary names in summary cells at the section level.  
Public PropertySummarySectionSelectedBackgroundGets or sets the default background color to use for summary cells at the section level.  
Public PropertySummarySectionTextColorGets or sets the default text color to use for summary cells at the section level.  
Public PropertyTabIndex (Inherited from Xamarin.Forms.VisualElement)
Public PropertyTranslationX (Inherited from Xamarin.Forms.VisualElement)
Public PropertyTranslationY (Inherited from Xamarin.Forms.VisualElement)
Public PropertyTriggers (Inherited from Xamarin.Forms.VisualElement)
Public PropertyVerticalOptions (Inherited from Xamarin.Forms.View)
Public PropertyVisual (Inherited from Xamarin.Forms.VisualElement)
Public PropertyWidth (Inherited from Xamarin.Forms.VisualElement)
Public PropertyWidthRequest (Inherited from Xamarin.Forms.VisualElement)
Public PropertyX (Inherited from Xamarin.Forms.VisualElement)
Public PropertyY (Inherited from Xamarin.Forms.VisualElement)
Protected Properties
 NameDescription
Protected Internal PropertyGestureController (Inherited from Xamarin.Forms.View)
See Also