SpreadsheetColumn Class

Holds and updates the information about the properties of each and every cell which are in view.

Inheritance

System.Object

SpreadsheetColumn

Namespace: Syncfusion.UI.Xaml.Spreadsheet

Assembly: Syncfusion.SfSpreadsheet.UWP.dll

Syntax

public class SpreadsheetColumn : GridColumn

Constructors

SpreadsheetColumn(SpreadsheetGrid)

Initializes a new instance of the SpreadsheetColumn class.

Declaration

public SpreadsheetColumn(SpreadsheetGrid grid)

Parameters

Type	Name	Description
SpreadsheetGrid	grid	An instance of SpreadsheetGrid

Properties

ExcelRange

Gets or sets the appropriate IRange.

Declaration

public IRange ExcelRange { get; set; }

Property Value

Type
IRange

ExcelStyle

Gets or set the appropriate ExcelStyle which might be modified based on conditional formats, table formats, etc.

Declaration

public IStyle ExcelStyle { get; set; }

Property Value

Type
IStyle

Renderer

Gets or sets the instance of ISpreadsheetCellRenderer which provides the functionality of cell renderers.

Declaration

public ISpreadsheetCellRenderer Renderer { get; set; }

Property Value

Type	Description
ISpreadsheetCellRenderer	An instance of ISpreadsheetCellRenderer.

Methods

Dispose(Boolean)

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

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	If set to true, to release both managed and unmanaged resources; false to release only unmanaged resources.

EnsureFloatingCellSize(List<GridColumn>, Size, Int32)

Calculates the size for floating cell and display text in the cell.

Declaration

protected override void EnsureFloatingCellSize(List<GridColumn> elements, Size cellSize, int arrayIndex)

Parameters

Type	Name	Description
System.Collections.Generic.List<Syncfusion.UI.Xaml.CellGrid.GridColumn>	elements	List of cell elements which are in view.
Windows.Foundation.Size	cellSize	Current size of the cell.
System.Int32	arrayIndex	Index of the visible columns.

EnsureFloatingCellSizeOnEdit(String)

Calculate the floating cell size on editing.

Declaration

protected override void EnsureFloatingCellSizeOnEdit(string text)

Parameters

Type	Name	Description
System.String	text	Display text in the cell.

GetCurrentCellRendererElement()

Used to get the edit UI element of current cell.

Declaration

protected override UIElement GetCurrentCellRendererElement()

Returns

Type	Description
Windows.UI.Xaml.UIElement	An UI element.

GetDisplayTextSize(String, Size, Boolean)

Calculate the display text size with help of MeasureText() based on cellsize and FloatingCellSize if FloatingCellSize is not an empty.

Declaration

protected override Size GetDisplayTextSize(string text, Size cellSize, bool wrapText)

Parameters

Type	Name	Description
System.String	text	Display text.
Windows.Foundation.Size	cellSize	Size of the cell.
System.Boolean	wrapText	true if textwrapping is applied; else false.

Returns

Type	Description
Windows.Foundation.Size	Size of the object.

GetTextAlignment()

Gets the HorizontalAlignment of the cell.

Declaration

protected override HorizontalAlignment GetTextAlignment()

Returns

Type	Description
Windows.UI.Xaml.HorizontalAlignment	HorizontalAlignment.

GetTextWrapping()

Determines if the text is wrapped or not.

Declaration

protected override bool GetTextWrapping()

Returns

Type	Description
System.Boolean	Returns true, if text is wrapped; otherwise false.

OnUpdateColumn(out FrameworkElement)

Update the column properties such as renderer, cell type, style info, row index, column index, cell element etc.

Declaration

protected override void OnUpdateColumn(out FrameworkElement oldElement)

Parameters

Type	Name	Description
Windows.UI.Xaml.FrameworkElement	oldElement	An element which maintains the Syncfusion.UI.Xaml.CellGrid.GridCell.

PointerMoved(PointerRoutedEventArgs)

Occurs when pointer/mouse hover the Syncfusion.UI.Xaml.CellGrid.GridCell

Declaration

protected override void PointerMoved(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e	An System.Windows.Input.MouseEventArgs that contains the event data.

PointerPressed(PointerRoutedEventArgs)

Occurs when pointer/mouse pressed on Syncfusion.UI.Xaml.CellGrid.GridCell.

Declaration

protected override void PointerPressed(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e	An System.Windows.Input.MouseEventArgs that contains the event data.

PointerReleased(PointerRoutedEventArgs)

Occurs when pointer/mouse released over Syncfusion.UI.Xaml.CellGrid.GridCell

Declaration

protected override void PointerReleased(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e	Mouse or Pointer eventargs.

SetTextWrapping(Boolean)

Set and reset the text wrapping while editing in floating cell.

Declaration

protected override void SetTextWrapping(bool setWrapText)

Parameters

Type	Name	Description
System.Boolean	setWrapText	True or False.

UpdateCellBorders()

Updates the cell borders for the Syncfusion.UI.Xaml.CellGrid.GridCell.

Declaration

protected override void UpdateCellBorders()

UpdateFloatingCellBorders()

Update the borders for floating cells.

Declaration

protected override void UpdateFloatingCellBorders()

UpdateSparklineBorder()

Declaration

protected override void UpdateSparklineBorder()