Class SpreadsheetColumn
Holds and updates the information about the properties of each and every cell which are in view.
Inherited Members
Namespace: Syncfusion.UI.Xaml.Spreadsheet
Assembly: Syncfusion.SfSpreadsheet.WPF.dll
Syntax
public class SpreadsheetColumn : GridColumn, IDisposable, IColumnElement
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. |
Overrides
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<GridColumn> | elements | List of cell elements which are in view. |
System.Windows.Size | cellSize | Current size of the cell. |
System.Int32 | arrayIndex | Index of the visible columns. |
Overrides
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. |
Overrides
GetCurrentCellRendererElement()
Used to get the edit UI element of current cell.
Declaration
protected override UIElement GetCurrentCellRendererElement()
Returns
Type | Description |
---|---|
System.Windows.UIElement | An UI element. |
Overrides
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. |
System.Windows.Size | cellSize | Size of the cell. |
System.Boolean | wrapText | true if textwrapping is applied; else false. |
Returns
Type | Description |
---|---|
System.Windows.Size | Size of the object. |
Overrides
GetTextAlignment()
Gets the HorizontalAlignment of the cell.
Declaration
protected override HorizontalAlignment GetTextAlignment()
Returns
Type | Description |
---|---|
System.Windows.HorizontalAlignment | HorizontalAlignment. |
Overrides
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. |
Overrides
OnRender(DrawingContext, Rect)
Used to render the borders, text, background, etc. of the GridCell.
Declaration
protected override void OnRender(DrawingContext drawingContext, Rect cellRect)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Media.DrawingContext | drawingContext | An instance of System.Windows.Media.DrawingContext. |
System.Windows.Rect | cellRect | An instance System.Windows.Rect of cell. |
Overrides
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 |
---|---|---|
System.Windows.FrameworkElement | oldElement | An element which maintains the GridCell. |
Overrides
PointerMoved(MouseEventArgs)
Occurs when pointer/mouse hover the GridCell
Declaration
protected override void PointerMoved(MouseEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseEventArgs | e | An System.Windows.Input.MouseEventArgs that contains the event data. |
Overrides
PointerPressed(MouseEventArgs)
Occurs when pointer/mouse pressed on GridCell.
Declaration
protected override void PointerPressed(MouseEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseEventArgs | e | An System.Windows.Input.MouseEventArgs that contains the event data. |
Overrides
PointerReleased(MouseButtonEventArgs)
Occurs when pointer/mouse released over GridCell
Declaration
protected override void PointerReleased(MouseButtonEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseButtonEventArgs | e | An System.Windows.Input.MouseButtonEventArgs that contains the event data. |
Overrides
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. |
Overrides
UpdateCellBorders()
Updates the cell borders for the GridCell.
Declaration
protected override void UpdateCellBorders()
Overrides
UpdateFloatingCellBorders()
Update the borders for floating cells.
Declaration
protected override void UpdateFloatingCellBorders()