Back to all docs
API Reference / Telerik.Windows.Controls.Spreadsheet.Worksheets.Layers / WorksheetUIUpdateContextBase

Class
WorksheetUIUpdateContextBase

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

Definition

Namespace:Telerik.Windows.Controls.Spreadsheet.Worksheets.Layers

Assembly:Telerik.Windows.Controls.Spreadsheet.dll

Syntax:
cs-api-definition
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.

Declaration

cs-api-definition
public DocumentTheme CurrentTheme { get; }

Property Value

DocumentTheme

The current theme.

Shapes

Gets the visible pictures.

Declaration

cs-api-definition
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

cs-api-definition
public bool ShowGridlines { get; set; }

Property Value

bool

The value indicating if the gridlines should be shown.

VisibleCellLayoutBoxes

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

Declaration

cs-api-definition
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

cs-api-definition
public IEnumerable<ColumnLayoutBox> VisibleColumnBoxes { get; }

Property Value

IEnumerable<ColumnLayoutBox>

The visible column boxes.

VisibleRowBoxes

Gets the visible row boxes.

Declaration

cs-api-definition
public IEnumerable<RowLayoutBox> VisibleRowBoxes { get; }

Property Value

IEnumerable<RowLayoutBox>

The visible row boxes.

Worksheet

Gets the worksheet.

Declaration

cs-api-definition
public Worksheet Worksheet { get; }

Property Value

Worksheet

The worksheet.

Methods

AddHyperlinkArea(CellIndex, Rect)

Adds the hyperlink area.

Declaration

cs-api-definition
public void AddHyperlinkArea(CellIndex cellIndex, Rect rect)

Parameters

cellIndex

CellIndex

Index of the cell.

rect

Rect

The rectangle.

CalculateIndent(CellIndex)

Calculates the indent.

Declaration

cs-api-definition
public int CalculateIndent(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

Returns

int

The indent.

GetActualBoundingRectangleByContentAlignment(CellLayoutBox)

Gets the actual bounding rectangle by content alignment.

Declaration

cs-api-definition
public Rect GetActualBoundingRectangleByContentAlignment(CellLayoutBox cellBox)

Parameters

cellBox

CellLayoutBox

The cell box.

Returns

Rect

The actual bounding rectangle.

GetBottomBorder(CellIndex)

Gets the bottom border.

Declaration

cs-api-definition
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

cs-api-definition
public Rect GetCellClipping(CellLayoutBox cellBox)

Parameters

cellBox

CellLayoutBox

The cell box.

Returns

Rect

The cell clipping rectangle.

GetCellContentSize(CellLayoutBox)

Gets the size of the cell content.

Declaration

cs-api-definition
public Size GetCellContentSize(CellLayoutBox cellBox)

Parameters

cellBox

CellLayoutBox

The cell box.

Returns

Size

The size of the cell content.

GetCellFormat(CellIndex)

Gets the cell format.

Declaration

cs-api-definition
public CellValueFormat GetCellFormat(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

Returns

CellValueFormat

The cell format.

GetCellValue(CellIndex)

Gets the cell value.

Declaration

cs-api-definition
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

cs-api-definition
public IDataValidationRule GetDataValidationRule(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

Returns

IDataValidationRule

The data validation rule.

GetDataValidationRuleResult(CellIndex)

Gets the data validation rule result.

Declaration

cs-api-definition
public bool GetDataValidationRuleResult(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

Returns

bool

The data validation rule result.

GetDiagonalDownBorder(CellIndex)

Gets the diagonal down border.

Declaration

cs-api-definition
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

cs-api-definition
public CellBorder GetDiagonalUpBorder(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

Returns

CellBorder

The diagonal up border.

GetFill(CellIndex)

Gets the fill.

Declaration

cs-api-definition
public IFill GetFill(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

Returns

IFill

Returns the fill.

GetFontProperties(CellIndex)

Gets the font properties.

Declaration

cs-api-definition
public FontProperties GetFontProperties(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

Returns

FontProperties

The font properties.

GetHorizontalAlignment(CellIndex)

Gets the horizontal alignment.

Declaration

cs-api-definition
public RadHorizontalAlignment GetHorizontalAlignment(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

Returns

RadHorizontalAlignment

The horizontal alignment.

GetHyperlinkArea(CellIndex)

Gets the hyperlink area.

Declaration

cs-api-definition
public Rect GetHyperlinkArea(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

Returns

Rect

The rectangle of the hyperlink area.

GetHyperlinkInfo(CellIndex)

Gets the hyperlink info.

Declaration

cs-api-definition
public HyperlinkInfo GetHyperlinkInfo(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

Returns

HyperlinkInfo

The hyperlink info.

GetHyperlinkInfo(int, int)

Gets the hyperlink info.

Declaration

cs-api-definition
public HyperlinkInfo GetHyperlinkInfo(int rowIndex, int columnIndex)

Parameters

rowIndex

int

Index of the row.

columnIndex

int

Index of the column.

Returns

HyperlinkInfo

GetIndentPropertyValue(CellIndex)

Gets the indent property value.

Declaration

cs-api-definition
public int GetIndentPropertyValue(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

Returns

int

The indent.

GetIsWrapped(CellIndex)

Gets the is wrapped.

Declaration

cs-api-definition
public bool GetIsWrapped(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

Returns

bool

Returns the is wrapped.

GetLeftBorder(CellIndex)

Gets the left border.

Declaration

cs-api-definition
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

cs-api-definition
public void GetPreviousNextNonEmptyNonMergedCells(CellIndex cellIndex, out CellLayoutBox previousCellBox, out CellLayoutBox nextCellBox)

Parameters

cellIndex

CellIndex

Index of the cell.

previousCellBox

CellLayoutBox

The previous cell box.

nextCellBox

CellLayoutBox

The next cell box.

GetRightBorder(CellIndex)

Gets the right border.

Declaration

cs-api-definition
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

cs-api-definition
public FloatingShapeBase GetShapeFromPoint(Point point)

Parameters

point

Point

The point.

Returns

FloatingShapeBase

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

GetTopBorder(CellIndex)

Gets the top border.

Declaration

cs-api-definition
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

cs-api-definition
public RadVerticalAlignment GetVerticalAlignment(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

Returns

RadVerticalAlignment

The vertical alignment.

GetVisibleCellBox(CellIndex)

Gets the visible cell box.

Declaration

cs-api-definition
public CellLayoutBox GetVisibleCellBox(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

Returns

CellLayoutBox

The visible cell box.

GetVisibleCellBox(int, int)

Gets the visible cell box.

Declaration

cs-api-definition
public CellLayoutBox GetVisibleCellBox(int rowIndex, int columnIndex)

Parameters

rowIndex

int

Index of the row.

columnIndex

int

Index of the column.

Returns

CellLayoutBox

The visible cell box.

GetVisibleColumnLayoutBox(int)

Gets the visible column layout box.

Declaration

cs-api-definition
public ColumnLayoutBox GetVisibleColumnLayoutBox(int columnIndex)

Parameters

columnIndex

int

Index of the column.

Returns

ColumnLayoutBox

The visible column layout box.

GetVisibleRowLayoutBox(int)

Gets the visible row layout box.

Declaration

cs-api-definition
public RowLayoutBox GetVisibleRowLayoutBox(int rowIndex)

Parameters

rowIndex

int

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)GetDataValidationRuleResult(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