Class WorksheetUIUpdateContextBase

Provides a base for the context of the worksheet UI update.

Inheritance
System.Object
UIUpdateContext
WorksheetUIUpdateContextBase
PrintWorksheetUIUpdateContext
WorksheetUIUpdateContext
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinForms.Controls.Spreadsheet.Worksheets.Layers
Assembly: Telerik.WinControls.RadSpreadsheet.dll

Syntax

public abstract class WorksheetUIUpdateContextBase : UIUpdateContext

Properties

CurrentTheme

Gets the current theme.

Declaration
public DocumentTheme CurrentTheme { get; }
Property Value
DocumentTheme

The current theme.

Shapes

Gets the visible pictures.

Declaration
public IEnumerable<FloatingShapeBase> Shapes { get; }
Property Value
System.Collections.Generic.IEnumerable<FloatingShapeBase>

The visible pictures.

ShowGridlines

Gets or sets a value indicating if the gridlines should be shown.

Declaration
public bool ShowGridlines { get; set; }
Property Value
System.Boolean

The value indicating if the gridlines should be shown.

VisibleCellLayoutBoxes

Gets the layout boxes of the cells which are currently visible.

Declaration
public Dictionary<ViewportPaneType, CellLayoutBox[]> VisibleCellLayoutBoxes { get; }
Property Value
System.Collections.Generic.Dictionary<ViewportPaneType, CellLayoutBox[]>

The layout boxes of the cells which are currently visible.

VisibleColumnBoxes

Gets the visible column boxes.

Declaration
public IEnumerable<ColumnLayoutBox> VisibleColumnBoxes { get; }
Property Value
System.Collections.Generic.IEnumerable<ColumnLayoutBox>

The visible column boxes.

VisibleRowBoxes

Gets the visible row boxes.

Declaration
public IEnumerable<RowLayoutBox> VisibleRowBoxes { get; }
Property Value
System.Collections.Generic.IEnumerable<RowLayoutBox>

The visible row boxes.

Worksheet

Gets the worksheet.

Declaration
public Worksheet Worksheet { get; }
Property Value
Worksheet

The worksheet.

Methods

AddHyperlinkArea(CellIndex, Rect)

Adds the hyperlink area.

Declaration
public void AddHyperlinkArea(CellIndex cellIndex, Rect rect)
Parameters
CellIndex cellIndex

Index of the cell.
System.Windows.Rect rect

The rectangle.

CalculateIndent(CellIndex)

Calculates the indent.

Declaration
public int CalculateIndent(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
System.Int32

The indent.

GetActualBoundingRectangleByContentAlignment(CellLayoutBox)

Gets the actual bounding rectangle by content alignment.

Declaration
public Rect GetActualBoundingRectangleByContentAlignment(CellLayoutBox cellBox)
Parameters
CellLayoutBox cellBox

The cell box.
Returns
System.Windows.Rect

The actual bounding rectangle.

GetBottomBorder(CellIndex)

Gets the bottom border.

Declaration
public CellBorder GetBottomBorder(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
CellBorder

Returns the bottom border.

GetCellClipping(CellLayoutBox)

Gets the cell clipping.

Declaration
public Rect GetCellClipping(CellLayoutBox cellBox)
Parameters
CellLayoutBox cellBox

The cell box.
Returns
System.Windows.Rect

The cell clipping rectangle.

GetCellContentSize(CellLayoutBox)

Gets the size of the cell content.

Declaration
public Size GetCellContentSize(CellLayoutBox cellBox)
Parameters
CellLayoutBox cellBox

The cell box.
Returns
System.Windows.Size

The size of the cell content.

GetCellFormat(CellIndex)

Gets the cell format.

Declaration
public CellValueFormat GetCellFormat(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
CellValueFormat

The cell format.

GetCellValue(CellIndex)

Gets the cell value.

Declaration
public ICellValue GetCellValue(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
ICellValue

THe cell value.

GetDataValidationRule(CellIndex)

Gets the data validation rule.

Declaration
public IDataValidationRule GetDataValidationRule(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
IDataValidationRule

The data validation rule

GetDiagonalDownBorder(CellIndex)

Gets the diagonal down border.

Declaration
public CellBorder GetDiagonalDownBorder(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
CellBorder

The diagonal down border.

GetDiagonalUpBorder(CellIndex)

Gets the diagonal up border.

Declaration
public CellBorder GetDiagonalUpBorder(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
CellBorder

The diagonal up border.

GetFill(CellIndex)

Gets the fill.

Declaration
public IFill GetFill(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
IFill

Returns the fill.

GetFontProperties(CellIndex)

Gets the font properties.

Declaration
public FontProperties GetFontProperties(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
FontProperties

The font properties.

GetHorizontalAlignment(CellIndex)

Gets the horizontal alignment.

Declaration
public RadHorizontalAlignment GetHorizontalAlignment(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
RadHorizontalAlignment

The horizontal alignment.

GetHyperlinkArea(CellIndex)

Gets the hyperlink area.

Declaration
public Rect GetHyperlinkArea(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
System.Windows.Rect

The rectangle of the hyperlink area.

GetHyperlinkInfo(Int32, Int32)

Gets the hyperlink info.

Declaration
public HyperlinkInfo GetHyperlinkInfo(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

Index of the row.
System.Int32 columnIndex

Index of the column.
Returns
HyperlinkInfo

GetHyperlinkInfo(CellIndex)

Gets the hyperlink info.

Declaration
public HyperlinkInfo GetHyperlinkInfo(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
HyperlinkInfo

The hyperlink info.

GetIndentPropertyValue(CellIndex)

Gets the indent property value.

Declaration
public int GetIndentPropertyValue(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
System.Int32

The indent.

GetIsWrapped(CellIndex)

Gets the is wrapped.

Declaration
public bool GetIsWrapped(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
System.Boolean

Returns the is wrapped.

GetLeftBorder(CellIndex)

Gets the left border.

Declaration
public CellBorder GetLeftBorder(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
CellBorder

Returns the left border.

GetPreviousNextNonEmptyNonMergedCells(CellIndex, out CellLayoutBox, out CellLayoutBox)

Gets the previous and the next non empty and non merged cells.

Declaration
public void GetPreviousNextNonEmptyNonMergedCells(CellIndex cellIndex, out CellLayoutBox previousCellBox, out CellLayoutBox nextCellBox)
Parameters
CellIndex cellIndex

Index of the cell.
CellLayoutBox previousCellBox

The previous cell box.
CellLayoutBox nextCellBox

The next cell box.

GetRightBorder(CellIndex)

Gets the right border.

Declaration
public CellBorder GetRightBorder(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
CellBorder

Returns the right border.

GetShapeFromPoint(Point)

Gets the shape which contains a given point of the layout if there is such.

Declaration
public FloatingShapeBase GetShapeFromPoint(Point point)
Parameters
System.Windows.Point point

The point.
Returns
FloatingShapeBase

Returns a shape if such is found, otherwise returns null.

GetTopBorder(CellIndex)

Gets the top border.

Declaration
public CellBorder GetTopBorder(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
CellBorder

Returns the top border.

GetVerticalAlignment(CellIndex)

Gets the vertical alignment.

Declaration
public RadVerticalAlignment GetVerticalAlignment(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
RadVerticalAlignment

The vertical alignment.

GetVisibleCellBox(Int32, Int32)

Gets the visible cell box.

Declaration
public CellLayoutBox GetVisibleCellBox(int rowIndex, int columnIndex)
Parameters
System.Int32 rowIndex

Index of the row.
System.Int32 columnIndex

Index of the column.
Returns
CellLayoutBox

The visible cell box.

GetVisibleCellBox(CellIndex)

Gets the visible cell box.

Declaration
public CellLayoutBox GetVisibleCellBox(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
CellLayoutBox

The visible cell box.

GetVisibleColumnLayoutBox(Int32)

Gets the visible column layout box.

Declaration
public ColumnLayoutBox GetVisibleColumnLayoutBox(int columnIndex)
Parameters
System.Int32 columnIndex

Index of the column.
Returns
ColumnLayoutBox

The visible column layout box.

GetVisibleRowLayoutBox(Int32)

Gets the visible row layout box.

Declaration
public RowLayoutBox GetVisibleRowLayoutBox(int rowIndex)
Parameters
System.Int32 rowIndex

Index of the row.
Returns
RowLayoutBox

The visible row layout box.

Extension Methods