Class DataGridStyle

Represents the style of a SfDataGrid control.

Inheritance

System.Object

DataGridStyle

DefaultStyle

Implements

System.IDisposable

Namespace: Syncfusion.SfDataGrid

Assembly: Syncfusion.SfDataGrid.iOS.dll

Syntax

public class DataGridStyle : Object, IDisposable

Remarks

DataGridStyle allows you to set style for all the elements in a SfDataGrid control. To apply a custom style to change the visual appearance of all the elements in the SfDataGrid, write a class overriding from DataGridStyle and assigning it to the GridStyle property.

Constructors

DataGridStyle()

Initializes a new instance of the DataGridStyle class.

Declaration

public DataGridStyle()

Properties

AlternatingRowColor

Gets or sets the alternate row color of the SfDataGrid. The alternation count of the rows for which the alternate row color can be customized by using AlternationCount property.

Declaration

public UIColor AlternatingRowColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The alternate row color of the SfDataGrid.

Remarks

SfDataGrid allows the user to set alternate row color by setting the AlternatingRowColor property to GridStyle property. SfDataGrid allows you to customize the rows for which the alternate row color needs to be updated based on the AlternationCount property.

Examples

dataGrid.GridStyle.AlternatingRowColor = UIColor.Blue;
dataGrid.AlternationCount = 3;

See Also

https://www.syncfusion.com/kb/6207/how-to-apply-alternate-row-colors-in-sfdatagrid

BorderColor

Gets or sets the border color of SfDataGrid.

Declaration

public UIColor BorderColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The border color of SfDataGrid.

CaptionRowBackgroundColor

Gets or sets the CaptionSummaryRow's background color.

Declaration

public UIColor CaptionRowBackgroundColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The CaptionSummaryRow's background color.

CaptionRowForegroundColor

Gets or sets the CaptionSummaryRow's foreground color.

Declaration

public UIColor CaptionRowForegroundColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The CaptionSummaryRow's foreground color.

CellBackground

Gets or sets the record's background color.

Declaration

public UIColor CellBackground { get; set; }

Property Value

Type	Description
UIKit.UIColor	The record's background color.

CellForeground

Gets or sets the record's foreground color.

Declaration

public UIColor CellForeground { get; set; }

Property Value

Type	Description
UIKit.UIColor	The record's foreground color.

DefaultRowColor

Gets or sets the default row color of SfDataGrid.

Declaration

public UIColor DefaultRowColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The default row color of SfDataGrid.

HeaderBackground

Gets or sets the header's background color.

Declaration

public UIColor HeaderBackground { get; set; }

Property Value

Type	Description
UIKit.UIColor	The header's background color.

HeaderForeground

Gets or sets the header's foreground color.

Declaration

public UIColor HeaderForeground { get; set; }

Property Value

Type	Description
UIKit.UIColor	The header's foreground color.

HeaderSortIndicatorDown

Gets or sets the UIKit.UIImage for header sort down indicator icon.

Declaration

public UIImage HeaderSortIndicatorDown { get; set; }

Property Value

Type	Description
UIKit.UIImage	The UIKit.UIImage for the header sort down indicator icon.

HeaderSortIndicatorUp

Gets or sets the UIKit.UIImage for header sort up indicator icon.

Declaration

public UIImage HeaderSortIndicatorUp { get; set; }

Property Value

Type	Description
UIKit.UIImage	The UIKit.UIImage for the header sort up indicator icon.

SelectionBackgroundColor

Gets or sets the background color of the selected row.

Declaration

public UIColor SelectionBackgroundColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The background color of the selected row.

SelectionForegroundColor

Gets or sets the foreground color of the selected row.

Declaration

public UIColor SelectionForegroundColor { get; set; }

Property Value

Type	Description
UIKit.UIColor	The foreground color of the selected row.

Methods

Dispose()

Releases the resources used by the component.

Declaration

public void Dispose()

Dispose(Boolean)

Releases the unmanaged resources used by the component and optionally releases the managed resources.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	if true - release both managed and unmanaged resources; if false - release only unmanaged resources.

GetAlternatingRowBackgroundColor()

Gets the AlternatingRow's background color.

Declaration

public virtual UIColor GetAlternatingRowBackgroundColor()

Returns

Type	Description
UIKit.UIColor	The AlternatingRow's background color.

GetBordercolor()

Declaration

public virtual UIColor GetBordercolor()

Returns

Type
UIKit.UIColor

GetBorderColor()

Gets the border color of SfDataGrid.

Declaration

public virtual UIColor GetBorderColor()

Returns

Type	Description
UIKit.UIColor	The border color of SfDataGrid.

GetBorderWidth()

Gets or sets the border width for the grid cells.

Declaration

public virtual float GetBorderWidth()

Returns

Type	Description
System.Single	The grid header cell border width

GetCaptionSummaryFontAttribute()

Gets the font attribute for the caption summary row text.

Declaration

public virtual UIFont GetCaptionSummaryFontAttribute()

Returns

Type	Description
UIKit.UIFont	Returns the font attribute for the caption summary row text.

GetCaptionSummaryRowBackgroundColor()

Gets the CaptionSummaryRow's background color.

Declaration

public virtual UIColor GetCaptionSummaryRowBackgroundColor()

Returns

Type	Description
UIKit.UIColor	The CaptionSummaryRow's background color.

GetCaptionSummaryRowBackgroundColor(Group)

Gets the CaptionSummaryRow's background color.

Declaration

public virtual UIColor GetCaptionSummaryRowBackgroundColor(Group group)

Parameters

Type	Name	Description
Group	group	The group.

Returns

Type	Description
UIKit.UIColor	The CaptionSummaryRow's background color.

GetCaptionSummaryRowForegroundColor()

Gets the CaptionSummaryRow's foreground color.

Declaration

public virtual UIColor GetCaptionSummaryRowForegroundColor()

Returns

Type	Description
UIKit.UIColor	The CaptionSummaryRow's foreground color.

GetCaptionSummaryRowForeGroundColor()

Declaration

public virtual UIColor GetCaptionSummaryRowForeGroundColor()

Returns

Type
UIKit.UIColor

GetCaptionSummaryRowForegroundColor(Group)

Gets the CaptionSummaryRow's foreground color for specified group.

Declaration

public virtual UIColor GetCaptionSummaryRowForegroundColor(Group group)

Parameters

Type	Name	Description
Group	group	The group

Returns

Type	Description
UIKit.UIColor	The CaptionSummaryRow's foreground color.

GetColumnDragDownIndicator()

Gets the UIKit.UIImage for the column drag down indicator icon.

Declaration

public virtual UIImage GetColumnDragDownIndicator()

Returns

Type	Description
UIKit.UIImage	The UIKit.UIImage for the column drag down indicator icon.

GetColumnDragUpIndicator()

Gets the UIKit.UIImage for the column drag up indicator icon.

Declaration

public virtual UIImage GetColumnDragUpIndicator()

Returns

Type	Description
UIKit.UIImage	The UIKit.UIImage for the column drag up indicator icon.

GetColumnDragViewBackgroundColor()

Gets the column drag view background color.

Declaration

protected virtual UIColor GetColumnDragViewBackgroundColor()

Returns

Type	Description
UIKit.UIColor	The column drag view background color.

GetColumnDragViewBorderColor()

Gets the column drag view border color.

Declaration

protected virtual UIColor GetColumnDragViewBorderColor()

Returns

Type	Description
UIKit.UIColor	The column drag view border color.

GetColumnDragViewForegroundColor()

Gets the column drag view foreground color.

Declaration

protected virtual UIColor GetColumnDragViewForegroundColor()

Returns

Type	Description
UIKit.UIColor	The column drag view foreground color.

GetColumnResizingIndicatorIcon()

Gets the column resizing indicator icon.

Declaration

public virtual UIImage GetColumnResizingIndicatorIcon()

Returns

Type	Description
UIKit.UIImage	Returns the column resizing indicator icon

GetCurrentCellBorderColor()

Gets the border color of the current cell which is focused.

Declaration

public virtual UIColor GetCurrentCellBorderColor()

Returns

Type	Description
UIKit.UIColor	The border color of the current cell which is focused.

GetCurrentCellBorderWidth()

Declaration

public virtual float GetCurrentCellBorderWidth()

Returns

Type
System.Single

GetGridLinesVisibility()

Gets the type of the borders to be drawn in SfDataGrid.

Declaration

public virtual GridLinesVisibility GetGridLinesVisibility()

Returns

Type	Description
GridLinesVisibility	The GridLinesVisibility for SfDataGrid.

GetGroupCollapseIcon()

Gets the UIKit.UIImage for the group collapse icon.

Declaration

public virtual UIImage GetGroupCollapseIcon()

Returns

Type	Description
UIKit.UIImage	The UIKit.UIImage for the group collapse icon.

GetGroupExpanderIcon()

Gets the UIKit.UIImage for the group expander icon.

Declaration

public virtual UIImage GetGroupExpanderIcon()

Returns

Type	Description
UIKit.UIImage	The UIKit.UIImage for the group expander icon.

GetGroupSummaryFontAttribute()

Gets the font attribute for the group summary row text.

Declaration

public virtual UIFont GetGroupSummaryFontAttribute()

Returns

Type	Description
UIKit.UIFont	Returns the font attribute for the group summary row text.

GetGroupSummaryRowBackgroundColor()

Gets the GroupSummaryRow's background color.

Declaration

public virtual UIColor GetGroupSummaryRowBackgroundColor()

Returns

Type	Description
UIKit.UIColor	The GroupSummaryRow's background color.

GetGroupSummaryRowForegroundColor()

Gets the GroupSummaryRow's foreground color.

Declaration

public virtual UIColor GetGroupSummaryRowForegroundColor()

Returns

Type	Description
UIKit.UIColor	The GroupSummaryRow's foreground color.

GetHeaderBackgroundColor()

Gets the header's background color.

Declaration

public virtual UIColor GetHeaderBackgroundColor()

Returns

Type	Description
UIKit.UIColor	The header's background color.

GetHeaderBorderColor()

Gets the Headerborder color of SfDataGrid.

Declaration

public virtual UIColor GetHeaderBorderColor()

Returns

Type	Description
UIKit.UIColor	The Headerborder color of SfDataGrid

GetHeaderBorderWidth()

Gets or sets the border width for the header cells.

Declaration

public virtual float GetHeaderBorderWidth()

Returns

Type	Description
System.Single	The grid header cell border width

GetHeaderForegroundColor()

Gets the header's foreground color.

Declaration

public virtual UIColor GetHeaderForegroundColor()

Returns

Type	Description
UIKit.UIColor	The header's foreground color.

GetHeaderSortIndicatorDown()

Gets the UIKit.UIImage for header sort down indicator icon.

Declaration

public virtual UIImage GetHeaderSortIndicatorDown()

Returns

Type	Description
UIKit.UIImage	The UIKit.UIImage for the header sort down indicator icon.

GetHeaderSortIndicatorUp()

Gets the UIKit.UIImage for header sort up indicator icon.

Declaration

public virtual UIImage GetHeaderSortIndicatorUp()

Returns

Type	Description
UIKit.UIImage	The UIKit.UIImage for the header sort up indicator icon.

GetIndentBackgroundColor(RowType)

Gets the IndentCell's background color.

Declaration

public virtual UIColor GetIndentBackgroundColor(RowType rowType)

Parameters

Type	Name	Description
RowType	rowType	The type of DataRow.

Returns

Type	Description
UIKit.UIColor	The IndentCell's background color.

GetLoadMoreViewBackgroundColor()

Gets the load more view background color.

Declaration

public virtual UIColor GetLoadMoreViewBackgroundColor()

Returns

Type	Description
UIKit.UIColor	The load more view background color.

GetLoadMoreViewForegroundColor()

Gets the load more view foreground color.

Declaration

public virtual UIColor GetLoadMoreViewForegroundColor()

Returns

Type	Description
UIKit.UIColor	The load more view foreground color.

GetRecordBackgroundColor()

Gets the record's background color.

Declaration

public virtual UIColor GetRecordBackgroundColor()

Returns

Type	Description
UIKit.UIColor	The record's background color.

GetRecordForegroundColor()

Gets the record's foreground color.

Declaration

public virtual UIColor GetRecordForegroundColor()

Returns

Type	Description
UIKit.UIColor	The record's foreground color.

GetResizingIndicatorColor()

Gets the color of the column resizing cursor.

Declaration

public virtual UIColor GetResizingIndicatorColor()

Returns

Type	Description
UIKit.UIColor	The color of the column resizing cursor.

GetRowDragDownIndicator()

Gets the UIKit.UIImage for the row drag down indicator icon.

Declaration

public virtual UIImage GetRowDragDownIndicator()

Returns

Type	Description
UIKit.UIImage	The UIKit.UIImage for the row drag down indicator icon.

GetRowDragUpIndicator()

Gets the UIKit.UIImage for the row drag up indicator icon.

Declaration

public virtual UIImage GetRowDragUpIndicator()

Returns

Type	Description
UIKit.UIImage	The UIKit.UIImage for the row drag up indicator icon.

GetSelectionBackgroundColor()

Gets the background color of the selected row.

Declaration

public virtual UIColor GetSelectionBackgroundColor()

Returns

Type	Description
UIKit.UIColor	The background color of the selected row.

GetSelectionForegroundColor()

Gets the foreground color of the selected row.

Declaration

public virtual UIColor GetSelectionForegroundColor()

Returns

Type	Description
UIKit.UIColor	The foreground color of the selected row.

GetSummaryVerticalLineVisibility()

Gets the visibility of the vertical borders in summary rows when ShowSummaryInRow is false.

Declaration

public virtual bool GetSummaryVerticalLineVisibility()

Returns

Type	Description
System.Boolean	Returns the visibility of the vertical borders in summary rows when ShowSummaryInRow is false.

GetTableSummaryBackgroundColor()

Gets the TableSummaryRow's background color.

Declaration

public virtual UIColor GetTableSummaryBackgroundColor()

Returns

Type	Description
UIKit.UIColor	The TableSummaryRow's background color.

GetTableSummaryFontAttribute()

Gets the font attribute for the table summary row text.

Declaration

public virtual UIFont GetTableSummaryFontAttribute()

Returns

Type	Description
UIKit.UIFont	Returns the font attribute for the table summary row text.

GetTableSummaryForegroundColor()

Gets the TableSummaryRow's foreground color.

Declaration

public virtual UIColor GetTableSummaryForegroundColor()

Returns

Type	Description
UIKit.UIColor	The TableSummaryRow's foreground color.

GetUnboundRowBackgroundColor()

Gets the UnboundRow's background color.

Declaration

public virtual UIColor GetUnboundRowBackgroundColor()

Returns

Type	Description
UIKit.UIColor	The UnboundRow's background color.

GetUnboundRowFontAttribute()

Gets the font attribute for the unbound row text.

Declaration

public virtual UIFont GetUnboundRowFontAttribute()

Returns

Type	Description
UIKit.UIFont	Returns the font attribute for the unbound row text

GetUnboundRowForegroundColor()

Gets the UnboundRow's Foreground color.

Declaration

public virtual UIColor GetUnboundRowForegroundColor()

Returns

Type	Description
UIKit.UIColor	The UnboundRow's Foreground color.

Implements

System.IDisposable

See Also

https://help.syncfusion.com/xamarin-ios/sfdatagrid/styles