ClassWorksheetUIUpdateContextBase
Provides a base for the context of the worksheet UI update.
Definition
Namespace:Telerik.WinForms.Controls.Spreadsheet.Worksheets.Layers
Assembly:Telerik.WinControls.RadSpreadsheet.dll
Syntax:
public abstract class WorksheetUIUpdateContextBase : UIUpdateContextInheritance: objectUIUpdateContextWorksheetUIUpdateContextBase
Derived Classes:
Inherited Members
Properties
CurrentTheme
Gets the current theme.
Declaration
public DocumentTheme CurrentTheme { get; }Property Value
The current theme.
Shapes
Gets the visible pictures.
Declaration
public IEnumerable<FloatingShapeBase> Shapes { get; }Property Value
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
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
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
The visible column boxes.
VisibleRowBoxes
Gets the visible row boxes.
Declaration
public IEnumerable<RowLayoutBox> VisibleRowBoxes { get; }Property Value
The visible row boxes.
Methods
AddHyperlinkArea(CellIndex, Rect)
Adds the hyperlink area.
CalculateIndent(CellIndex)
Calculates the indent.
GetActualBoundingRectangleByContentAlignment(CellLayoutBox)
Gets the actual bounding rectangle by content alignment.
Declaration
public Rect GetActualBoundingRectangleByContentAlignment(CellLayoutBox cellBox)Parameters
cellBox
The cell box.
Returns
The actual bounding rectangle.
GetBottomBorder(CellIndex)
Gets the bottom border.
Declaration
public CellBorder GetBottomBorder(CellIndex cellIndex)Parameters
cellIndex
Index of the cell.
Returns
Returns the bottom border.
GetCellClipping(CellLayoutBox)
Gets the cell clipping.
Declaration
public Rect GetCellClipping(CellLayoutBox cellBox)Parameters
cellBox
The cell box.
Returns
The cell clipping rectangle.
GetCellContentSize(CellLayoutBox)
Gets the size of the cell content.
Declaration
public Size GetCellContentSize(CellLayoutBox cellBox)Parameters
cellBox
The cell box.
Returns
The size of the cell content.
GetCellFormat(CellIndex)
Gets the cell format.
Declaration
public CellValueFormat GetCellFormat(CellIndex cellIndex)Parameters
cellIndex
Index of the cell.
Returns
The cell format.
GetCellValue(CellIndex)
Gets the cell value.
Declaration
public ICellValue GetCellValue(CellIndex cellIndex)Parameters
cellIndex
Index of the cell.
Returns
THe cell value.
GetDataValidationRule(CellIndex)
Gets the data validation rule.
Declaration
public IDataValidationRule GetDataValidationRule(CellIndex cellIndex)Parameters
cellIndex
Index of the cell.
Returns
The data validation rule
GetDiagonalDownBorder(CellIndex)
Gets the diagonal down border.
Declaration
public CellBorder GetDiagonalDownBorder(CellIndex cellIndex)Parameters
cellIndex
Index of the cell.
Returns
The diagonal down border.
GetDiagonalUpBorder(CellIndex)
Gets the diagonal up border.
Declaration
public CellBorder GetDiagonalUpBorder(CellIndex cellIndex)Parameters
cellIndex
Index of the cell.
Returns
The diagonal up border.
GetFill(CellIndex)
Gets the fill.
GetFontProperties(CellIndex)
Gets the font properties.
Declaration
public FontProperties GetFontProperties(CellIndex cellIndex)Parameters
cellIndex
Index of the cell.
Returns
The font properties.
GetHorizontalAlignment(CellIndex)
Gets the horizontal alignment.
Declaration
public RadHorizontalAlignment GetHorizontalAlignment(CellIndex cellIndex)Parameters
cellIndex
Index of the cell.
Returns
The horizontal alignment.
GetHyperlinkArea(CellIndex)
Gets the hyperlink area.
GetHyperlinkInfo(CellIndex)
Gets the hyperlink info.
Declaration
public HyperlinkInfo GetHyperlinkInfo(CellIndex cellIndex)Parameters
cellIndex
Index of the cell.
Returns
The hyperlink info.
GetHyperlinkInfo(int, int)
Gets the hyperlink info.
Declaration
public HyperlinkInfo GetHyperlinkInfo(int rowIndex, int columnIndex)Parameters
rowIndex
Index of the row.
columnIndex
Index of the column.
Returns
GetIndentPropertyValue(CellIndex)
Gets the indent property value.
GetIsWrapped(CellIndex)
Gets the is wrapped.
GetLeftBorder(CellIndex)
Gets the left border.
Declaration
public CellBorder GetLeftBorder(CellIndex cellIndex)Parameters
cellIndex
Index of the cell.
Returns
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
Index of the cell.
previousCellBox
The previous cell box.
nextCellBox
The next cell box.
GetRightBorder(CellIndex)
Gets the right border.
Declaration
public CellBorder GetRightBorder(CellIndex cellIndex)Parameters
cellIndex
Index of the cell.
Returns
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
point
The point.
Returns
Returns a shape if such is found, otherwise returns null.
GetTopBorder(CellIndex)
Gets the top border.
Declaration
public CellBorder GetTopBorder(CellIndex cellIndex)Parameters
cellIndex
Index of the cell.
Returns
Returns the top border.
GetVerticalAlignment(CellIndex)
Gets the vertical alignment.
Declaration
public RadVerticalAlignment GetVerticalAlignment(CellIndex cellIndex)Parameters
cellIndex
Index of the cell.
Returns
The vertical alignment.
GetVisibleCellBox(CellIndex)
Gets the visible cell box.
Declaration
public CellLayoutBox GetVisibleCellBox(CellIndex cellIndex)Parameters
cellIndex
Index of the cell.
Returns
The visible cell box.
GetVisibleCellBox(int, int)
Gets the visible cell box.
Declaration
public CellLayoutBox GetVisibleCellBox(int rowIndex, int columnIndex)Parameters
rowIndex
Index of the row.
columnIndex
Index of the column.
Returns
The visible cell box.
GetVisibleColumnLayoutBox(int)
Gets the visible column layout box.
Declaration
public ColumnLayoutBox GetVisibleColumnLayoutBox(int columnIndex)Parameters
columnIndex
Index of the column.
Returns
The visible column layout box.
GetVisibleRowLayoutBox(int)
Gets the visible row layout box.
Declaration
public RowLayoutBox GetVisibleRowLayoutBox(int rowIndex)Parameters
rowIndex
Index of the row.
Returns
The visible row layout box.