Back to all docs
API Reference / Telerik.WinForms.Controls.Spreadsheet.Worksheets.Layers / WorksheetUIUpdateContextBase
New to Telerik UI for WinForms? Start a free 30-day trial

WorksheetUIUpdateContextBase

Class

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:
C#
public abstract class WorksheetUIUpdateContextBase : UIUpdateContext

Inheritance: objectUIUpdateContextWorksheetUIUpdateContextBase

Derived Classes: PrintWorksheetUIUpdateContextWorksheetUIUpdateContext

Inherited Members UIUpdateContext.Translate(Point, ViewportPaneType)UIUpdateContext.Translate(Rect, ViewportPaneType)UIUpdateContext.OwnerUIUpdateContext.SheetViewportUIUpdateContext.ScaleFactor

Properties

CurrentTheme

Gets the current theme.

C#
public DocumentTheme CurrentTheme { get; }
Property Value:

The current theme.

Shapes

IEnumerable<FloatingShapeBase>

Gets the visible pictures.

C#
public IEnumerable<FloatingShapeBase> Shapes { get; }
Property Value:

The visible pictures.

ShowGridlines

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

C#
public bool ShowGridlines { get; set; }
Property Value:

The value indicating if the gridlines should be shown.

VisibleCellLayoutBoxes

Dictionary<ViewportPaneType, CellLayoutBox[]>

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

C#
public Dictionary<ViewportPaneType, CellLayoutBox[]> VisibleCellLayoutBoxes { get; }
Property Value:

The layout boxes of the cells which are currently visible.

VisibleColumnBoxes

IEnumerable<ColumnLayoutBox>

Gets the visible column boxes.

C#
public IEnumerable<ColumnLayoutBox> VisibleColumnBoxes { get; }
Property Value:

The visible column boxes.

VisibleRowBoxes

IEnumerable<RowLayoutBox>

Gets the visible row boxes.

C#
public IEnumerable<RowLayoutBox> VisibleRowBoxes { get; }
Property Value:

The visible row boxes.

Worksheet

Gets the worksheet.

C#
public Worksheet Worksheet { get; }
Property Value:

The worksheet.

Methods

AddHyperlinkArea(CellIndex, Rect)

Adds the hyperlink area.

C#
public void AddHyperlinkArea(CellIndex cellIndex, Rect rect)
Parameters:cellIndexCellIndex

Index of the cell.

rectRect

The rectangle.

CalculateIndent(CellIndex)

Calculates the indent.

C#
public int CalculateIndent(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

int

The indent.

GetActualBoundingRectangleByContentAlignment(CellLayoutBox)

Gets the actual bounding rectangle by content alignment.

C#
public Rect GetActualBoundingRectangleByContentAlignment(CellLayoutBox cellBox)
Parameters:cellBoxCellLayoutBox

The cell box.

Returns:

Rect

The actual bounding rectangle.

GetBottomBorder(CellIndex)

Gets the bottom border.

C#
public CellBorder GetBottomBorder(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

CellBorder

Returns the bottom border.

GetCellClipping(CellLayoutBox)

Gets the cell clipping.

C#
public Rect GetCellClipping(CellLayoutBox cellBox)
Parameters:cellBoxCellLayoutBox

The cell box.

Returns:

Rect

The cell clipping rectangle.

GetCellContentSize(CellLayoutBox)

Gets the size of the cell content.

C#
public Size GetCellContentSize(CellLayoutBox cellBox)
Parameters:cellBoxCellLayoutBox

The cell box.

Returns:

Size

The size of the cell content.

GetCellFormat(CellIndex)

Gets the cell format.

C#
public CellValueFormat GetCellFormat(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

CellValueFormat

The cell format.

GetCellValue(CellIndex)

Gets the cell value.

C#
public ICellValue GetCellValue(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

ICellValue

THe cell value.

GetDataValidationRule(CellIndex)

Gets the data validation rule.

C#
public IDataValidationRule GetDataValidationRule(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

IDataValidationRule

The data validation rule

GetDiagonalDownBorder(CellIndex)

Gets the diagonal down border.

C#
public CellBorder GetDiagonalDownBorder(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

CellBorder

The diagonal down border.

GetDiagonalUpBorder(CellIndex)

Gets the diagonal up border.

C#
public CellBorder GetDiagonalUpBorder(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

CellBorder

The diagonal up border.

GetFill(CellIndex)

Gets the fill.

C#
public IFill GetFill(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

IFill

Returns the fill.

GetFontProperties(CellIndex)

Gets the font properties.

C#
public FontProperties GetFontProperties(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

FontProperties

The font properties.

GetHorizontalAlignment(CellIndex)

Gets the horizontal alignment.

C#
public RadHorizontalAlignment GetHorizontalAlignment(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

RadHorizontalAlignment

The horizontal alignment.

GetHyperlinkArea(CellIndex)

Gets the hyperlink area.

C#
public Rect GetHyperlinkArea(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

Rect

The rectangle of the hyperlink area.

GetHyperlinkInfo(CellIndex)

Gets the hyperlink info.

C#
public HyperlinkInfo GetHyperlinkInfo(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

HyperlinkInfo

The hyperlink info.

GetHyperlinkInfo(int, int)

Gets the hyperlink info.

C#
public HyperlinkInfo GetHyperlinkInfo(int rowIndex, int columnIndex)
Parameters:rowIndexint

Index of the row.

columnIndexint

Index of the column.

Returns:

HyperlinkInfo

GetIndentPropertyValue(CellIndex)

Gets the indent property value.

C#
public int GetIndentPropertyValue(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

int

The indent.

GetIsWrapped(CellIndex)

Gets the is wrapped.

C#
public bool GetIsWrapped(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

bool

Returns the is wrapped.

GetLeftBorder(CellIndex)

Gets the left border.

C#
public CellBorder GetLeftBorder(CellIndex cellIndex)
Parameters:cellIndexCellIndex

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.

C#
public void GetPreviousNextNonEmptyNonMergedCells(CellIndex cellIndex, out CellLayoutBox previousCellBox, out CellLayoutBox nextCellBox)
Parameters:cellIndexCellIndex

Index of the cell.

previousCellBoxCellLayoutBox

The previous cell box.

nextCellBoxCellLayoutBox

The next cell box.

GetRightBorder(CellIndex)

Gets the right border.

C#
public CellBorder GetRightBorder(CellIndex cellIndex)
Parameters:cellIndexCellIndex

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.

C#
public FloatingShapeBase GetShapeFromPoint(Point point)
Parameters:pointPoint

The point.

Returns:

FloatingShapeBase

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

GetTopBorder(CellIndex)

Gets the top border.

C#
public CellBorder GetTopBorder(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

CellBorder

Returns the top border.

GetVerticalAlignment(CellIndex)

Gets the vertical alignment.

C#
public RadVerticalAlignment GetVerticalAlignment(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

RadVerticalAlignment

The vertical alignment.

GetVisibleCellBox(CellIndex)

Gets the visible cell box.

C#
public CellLayoutBox GetVisibleCellBox(CellIndex cellIndex)
Parameters:cellIndexCellIndex

Index of the cell.

Returns:

CellLayoutBox

The visible cell box.

GetVisibleCellBox(int, int)

Gets the visible cell box.

C#
public CellLayoutBox GetVisibleCellBox(int rowIndex, int columnIndex)
Parameters:rowIndexint

Index of the row.

columnIndexint

Index of the column.

Returns:

CellLayoutBox

The visible cell box.

GetVisibleColumnLayoutBox(int)

Gets the visible column layout box.

C#
public ColumnLayoutBox GetVisibleColumnLayoutBox(int columnIndex)
Parameters:columnIndexint

Index of the column.

Returns:

ColumnLayoutBox

The visible column layout box.

GetVisibleRowLayoutBox(int)

Gets the visible row layout box.

C#
public RowLayoutBox GetVisibleRowLayoutBox(int rowIndex)
Parameters:rowIndexint

Index of the row.

Returns:

RowLayoutBox

The visible row layout box.

In this article
DefinitionPropertiesCurrentThemeShapesShowGridlinesVisibleCellLayoutBoxesVisibleColumnBoxesVisibleRowBoxesWorksheetMethodsAddHyperlinkArea(CellIndex, Rect)CalculateIndent(CellIndex)GetActualBoundingRectangleByContentAlignment(CellLayoutBox)GetBottomBorder(CellIndex)GetCellClipping(CellLayoutBox)GetCellContentSize(CellLayoutBox)GetCellFormat(CellIndex)GetCellValue(CellIndex)GetDataValidationRule(CellIndex)GetDiagonalDownBorder(CellIndex)GetDiagonalUpBorder(CellIndex)GetFill(CellIndex)GetFontProperties(CellIndex)GetHorizontalAlignment(CellIndex)GetHyperlinkArea(CellIndex)GetHyperlinkInfo(CellIndex)GetHyperlinkInfo(int, int)GetIndentPropertyValue(CellIndex)GetIsWrapped(CellIndex)GetLeftBorder(CellIndex)GetPreviousNextNonEmptyNonMergedCells(CellIndex, out CellLayoutBox, out CellLayoutBox)GetRightBorder(CellIndex)GetShapeFromPoint(Point)GetTopBorder(CellIndex)GetVerticalAlignment(CellIndex)GetVisibleCellBox(CellIndex)GetVisibleCellBox(int, int)GetVisibleColumnLayoutBox(int)GetVisibleRowLayoutBox(int)
Not finding the help you need?
Contact Support