Class CellArgs

Provides layout information about a cell such as the VisibleRow, VisibleColumb, the CellRect, Covered Cell Span and also cell style information.

Inheritance

System.Object

CellArgs

ArrangeCellArgs

RenderCellArgs

Namespace: Syncfusion.Windows.Controls.Cells

Assembly: Syncfusion.GridCommon.WPF.dll

Syntax

public class CellArgs : Object

Constructors

CellArgs(VirtualizingCellsControl, VisibleLineInfo, VisibleLineInfo, Rect, IRenderCellInfo)

Initializes a new instance of the CellArgs class.

Declaration

public CellArgs(VirtualizingCellsControl cellsControl, VisibleLineInfo visibleRow, VisibleLineInfo visibleColumn, Rect cellRect, IRenderCellInfo ci)

Parameters

Type	Name	Description
VirtualizingCellsControl	cellsControl	The cells control.
VisibleLineInfo	visibleRow	The visible row.
VisibleLineInfo	visibleColumn	The visible column.
System.Windows.Rect	cellRect	The cell rect.
IRenderCellInfo	ci	The cell style.

Properties

CellClipRect

Gets the cells clipping rectangle.

Declaration

public Rect CellClipRect { get; }

Property Value

Type	Description
System.Windows.Rect	The cells clipping rectangle.

CellInfo

Gets the cell style information.

Declaration

public IRenderCellInfo CellInfo { get; }

Property Value

Type	Description
IRenderCellInfo	The cell style information.

CellRect

Gets or sets the cell rectangle.

Declaration

public Rect CellRect { get; set; }

Property Value

Type	Description
System.Windows.Rect	The cell rectangle.

CellRowColumnIndex

Gets the index of the cell row column.

Declaration

public RowColumnIndex CellRowColumnIndex { get; }

Property Value

Type	Description
RowColumnIndex	The index of the cell row column.

CellsControl

Gets the cells control.

Declaration

public VirtualizingCellsControl CellsControl { get; }

Property Value

Type	Description
VirtualizingCellsControl	The cells control.

CellUIElements

Gets the cell visuals.

Declaration

public virtual CellUIElements CellUIElements { get; }

Property Value

Type	Description
CellUIElements	The cell visuals.

ColumnIndex

Gets the absolute index of the column.

Declaration

public int ColumnIndex { get; }

Property Value

Type	Description
System.Int32	The index of the column.

IsColumnFooterAtBottom

Gets a value indicating whether this instance is column footer at bottom.

Declaration

public bool IsColumnFooterAtBottom { get; }

Property Value

Type	Description
System.Boolean	true if this instance is column footer at bottom; otherwise, false.

IsColumnHeaderAtTop

Gets a value indicating whether this instance is column header at top.

Declaration

public bool IsColumnHeaderAtTop { get; }

Property Value

Type	Description
System.Boolean	true if this instance is column header at top; otherwise, false.

IsRowFooterAtRightSide

Gets a value indicating whether this instance is row footer at right side.

Declaration

public bool IsRowFooterAtRightSide { get; }

Property Value

Type	Description
System.Boolean	true if this instance is row footer at right side; otherwise, false.

IsRowHeaderAtLeftSide

Gets a value indicating whether this instance is row header at left side.

Declaration

public bool IsRowHeaderAtLeftSide { get; }

Property Value

Type	Description
System.Boolean	true if this instance is row header at left side; otherwise, false.

OriginalCellRect

Gets the original cell rectangle. This might differ from the CellRect if the CellRect was modified. For example OnArrangeCell and OnRenderCell in VirtualizingCellsControl substract border from the CellRect.

Declaration

public Rect OriginalCellRect { get; }

Property Value

Type	Description
System.Windows.Rect	The original cell rectangle.

RowIndex

Gets the absolute index of the row.

Declaration

public int RowIndex { get; }

Property Value

Type	Description
System.Int32	The index of the row.

VisibleColumn

Gets the visible column.

Declaration

public VisibleLineInfo VisibleColumn { get; }

Property Value

Type	Description
VisibleLineInfo	The visible column.

VisibleCoveredCellInfo

Gets the visible covered cell info.

Declaration

public VisibleCoveredCellInfo VisibleCoveredCellInfo { get; }

Property Value

Type	Description
VisibleCoveredCellInfo	The visible covered cell info.

VisibleoverlappingCellInfo

Declaration

public VisibleOverlappingCellInfo VisibleoverlappingCellInfo { get; }

Property Value

Type
VisibleOverlappingCellInfo

VisibleRow

Gets the visible row.

Declaration

public VisibleLineInfo VisibleRow { get; }

Property Value

Type	Description
VisibleLineInfo	The visible row.

Methods

SubtractBorderMargins(Rect, Thickness)

Remove border margins to get cells client area.

Declaration

public Rect SubtractBorderMargins(Rect cellRect, Thickness mi)

Parameters

Type	Name	Description
System.Windows.Rect	cellRect
System.Windows.Thickness	mi

Returns

Type
System.Windows.Rect