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

Class
RadWorksheetEditor

Represents the RadWorksheetEditor.

Definition

Namespace:Telerik.Windows.Controls.Spreadsheet.Worksheets

Assembly:Telerik.Windows.Controls.Spreadsheet.dll

Syntax:
cs-api-definition
public class RadWorksheetEditor : RadSheetEditorBase<Worksheet>, IRadSheetEditor, ICommandDescriptorsProvider, ISheetEditor, IUILayerOwner, IDisposable, IWeakEventListener

Inheritance: objectControlBaseRadSheetEditorBaseRadSheetEditorBase<Worksheet>RadWorksheetEditor

Implements: ICommandDescriptorsProviderIDisposableIRadSheetEditorISheetEditorIUILayerOwnerIWeakEventListener

Inherited Members RadSheetEditorBase<Worksheet>.IsSheetValid(Sheet)RadSheetEditorBase<Worksheet>.SheetRadSheetEditorBase.ScaleFactorPropertyRadSheetEditorBase.AllowScalingPropertyRadSheetEditorBase.DoOnSheetChanging()RadSheetEditorBase.DoOnSheetChanged()RadSheetEditorBase.GetSheetValue()RadSheetEditorBase.SetSheetValue(Sheet)RadSheetEditorBase.OnOwnerTemplateApplying()RadSheetEditorBase.OnScrollBarProviderChanging()RadSheetEditorBase.OnKeyDown(KeyEventArgs)RadSheetEditorBase.OnCommandDescriptorsChanged()RadSheetEditorBase.OnPreviewSheetChanging()RadSheetEditorBase.OnPreviewSheetChanged()RadSheetEditorBase.OnUICommandExecuting(UICommandExecutingEventArgs)RadSheetEditorBase.OnUICommandExecuted(UICommandExecutedEventArgs)RadSheetEditorBase.OnUICommandError(UICommandErrorEventArgs)RadSheetEditorBase.OwnerRadSheetEditorBase.ScrollBarsProviderRadSheetEditorBase.KeyBindingsRadSheetEditorBase.CommandDescriptorsRadSheetEditorBase.ScaleFactorRadSheetEditorBase.AllowScalingRadSheetEditorBase.CommandDescriptorsChangedRadSheetEditorBase.PreviewSheetChangingRadSheetEditorBase.SheetChangingRadSheetEditorBase.PreviewSheetChangedRadSheetEditorBase.SheetChangedRadSheetEditorBase.ScaleFactorChangedRadSheetEditorBase.UICommandExecutingRadSheetEditorBase.UICommandExecutedRadSheetEditorBase.UICommandErrorControlBase.GetTemplateChild<T>(string)ControlBase.GetRequiredTemplateChild<T>(string, bool)

Constructors

RadWorksheetEditor()

Initializes a new instance of the RadWorksheetEditor class.

Declaration

cs-api-definition
public RadWorksheetEditor()

RadWorksheetEditor(SizeI)

Initializes a new instance of the RadWorksheetEditor class.

Declaration

cs-api-definition
public RadWorksheetEditor(SizeI visibleSize)

Parameters

visibleSize

SizeI

Size of the visible.

Fields

LeftMarginsPanelName

Left margins panel name.

Declaration

cs-api-definition
public static readonly string LeftMarginsPanelName

Field Value

string

TopMarginsPanelName

Top margins panel name.

Declaration

cs-api-definition
public static readonly string TopMarginsPanelName

Field Value

string

Properties

ActivePresenter

Gets the active presenter.

Declaration

cs-api-definition
public IRadWorksheetEditorPresenter ActivePresenter { get; }

Property Value

IRadWorksheetEditorPresenter

The active presenter.

Commands

Gets the commands.

Declaration

cs-api-definition
public RadWorksheetEditorCommands Commands { get; }

Property Value

RadWorksheetEditorCommands

The commands.

Dialogs

Gets the dialogs.

Declaration

cs-api-definition
public WorksheetEditorDialogs Dialogs { get; }

Property Value

WorksheetEditorDialogs

The dialogs.

FrozenCellIndex

Gets the index of the cell below the top frozen pane and to the right of the left frozen pane.

Declaration

cs-api-definition
public CellIndex FrozenCellIndex { get; }

Property Value

CellIndex

The index of the frozen cell.

HorizontalScrollMode

Gets or sets the horizontal scroll mode.

Declaration

cs-api-definition
public ScrollMode HorizontalScrollMode { get; set; }

Property Value

ScrollMode

The horizontal scroll mode.

IsHorizontalViewportUpdateSuspended

Gets the value indicating if the horizontal viewport update is suspended.

Declaration

cs-api-definition
public bool IsHorizontalViewportUpdateSuspended { get; }

Property Value

bool

The value indicating if the horizontal viewport update is suspended.

IsVerticalViewportUpdateSuspended

Gets the value indicating if the vertical viewport update is suspended.

Declaration

cs-api-definition
public bool IsVerticalViewportUpdateSuspended { get; }

Property Value

bool

The value indicating if the vertical viewport update is suspended.

RadWorksheetCommandDescriptors

Allows you to get or set the command descriptors. Used when overriding the default command descriptors with custom ones.

Declaration

cs-api-definition
public CommandDescriptors RadWorksheetCommandDescriptors { get; set; }

Property Value

CommandDescriptors

Selection

Gets the selection.

Declaration

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

Property Value

Selection

The selection.

SheetViewport

Gets the sheet viewport.

Declaration

cs-api-definition
public override SheetViewport SheetViewport { get; }

Property Value

SheetViewport

The sheet viewport.

Overrides RadSheetEditorBase.SheetViewport

ShowGridlines

Gets or sets a value indicating whether to show gridlines.

Declaration

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

Property Value

bool

The value indicating whether to show gridlines.

ShowRowColumnHeadings

Gets or sets a value indicating whether to show row and column headings.

Declaration

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

Property Value

bool

The value indicating whether to show row and column headings.

TopLeftCellIndex

Gets the index of the top left cell.

Declaration

cs-api-definition
public CellIndex TopLeftCellIndex { get; }

Property Value

CellIndex

The index of the top left cell.

VerticalScrollMode

Gets or sets the vertical scroll mode.

Declaration

cs-api-definition
public ScrollMode VerticalScrollMode { get; set; }

Property Value

ScrollMode

The vertical scroll mode.

VisibleSize

Gets the size of the visible.

Declaration

cs-api-definition
public SizeI VisibleSize { get; }

Property Value

SizeI

The size of the visible.

Worksheet

Gets or sets the worksheet.

Declaration

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

Property Value

Worksheet

The worksheet.

Methods

BringIntoView(CellIndex)

Brings the into view.

Declaration

cs-api-definition
public void BringIntoView(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

CircleInvalidData()

Circles the invalid data.

Declaration

cs-api-definition
public void CircleInvalidData()

Clear(ClearType)

Clears the selected cells.

Declaration

cs-api-definition
public void Clear(ClearType clearType)

Parameters

clearType

ClearType

Type of the clear.

ClearInvalidDataCircles()

Clears the invalid data circles.

Declaration

cs-api-definition
public void ClearInvalidDataCircles()

Copy()

Copies the selected cell values and formatting.

Declaration

cs-api-definition
public bool Copy()

Returns

bool

True if succeed.

CreateHistoryState()

Creates the state of the history.

Declaration

cs-api-definition
public RadWorksheetEditorHistoryState CreateHistoryState()

Returns

RadWorksheetEditorHistoryState

The state of the history.

Cut()

Cuts the selected cell values and formatting.

Declaration

cs-api-definition
public void Cut()

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

cs-api-definition
public void Dispose()

Implements IDisposable.Dispose()

Dispose(bool)

Disposes the specified clean up managed resources.

Declaration

cs-api-definition
protected virtual void Dispose(bool cleanUpManagedResources)

Parameters

cleanUpManagedResources

bool

The clean up managed resources.

FreezePanes(CellIndex)

Freezes the panes.

Declaration

cs-api-definition
public void FreezePanes(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

Index of the cell.

GetCellLayoutBox(CellIndex)

Gets the cell layout box.

Declaration

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

Parameters

cellIndex

CellIndex

Index of the cell.

Returns

CellLayoutBox

The cell layout box.

GetCellLayoutBox(int, int)

Gets the cell layout box.

Declaration

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

Parameters

rowIndex

int

Index of the row.

columnIndex

int

Index of the column.

Returns

CellLayoutBox

The cell layout box.

InvalidatePresenterLayout()

Invalidates the presenter layout.

Declaration

cs-api-definition
public void InvalidatePresenterLayout()

MeasureOverride(Size)

When overridden in a derived class, measures the size in layout required for child elements and determines a size for the FrameworkElement-derived class.

Declaration

cs-api-definition
protected override Size MeasureOverride(Size availableSize)

Parameters

availableSize

Size

The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

Returns

Size

The size that this element determines it needs during layout, based on its calculations of child element sizes.

OnActivePresenterChanged()

Called when the active presenter is changed.

Declaration

cs-api-definition
protected virtual void OnActivePresenterChanged()

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call .

Declaration

cs-api-definition
public override void OnApplyTemplate()

OnGotFocus(RoutedEventArgs)

Raises the  routed event by using the event data provided.

Declaration

cs-api-definition
protected override void OnGotFocus(RoutedEventArgs e)

Parameters

e

RoutedEventArgs

A RoutedEventArgs that contains event data. This event data must contain the identifier for the event.

OnHyperlinkClicked(HyperlinkClickedEventArgs)

Called when a hyperlink in the document is clicked.

Declaration

cs-api-definition
protected virtual void OnHyperlinkClicked(HyperlinkClickedEventArgs args)

Parameters

args

HyperlinkClickedEventArgs

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

OnOwnerChanged()

Called when the owner is changed.

Declaration

cs-api-definition
protected override void OnOwnerChanged()

Overrides RadSheetEditorBase.OnOwnerChanged()

OnOwnerChanging()

Raises the event.

Declaration

cs-api-definition
protected override void OnOwnerChanging()

Overrides RadSheetEditorBase.OnOwnerChanging()

OnPreviewKeyDown(KeyEventArgs)

Invoked when an unhandled  attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration

cs-api-definition
protected override void OnPreviewKeyDown(KeyEventArgs e)

Parameters

e

KeyEventArgs

The KeyEventArgs that contains the event data.

OnScaleFactorChanged()

Raises the event.

Declaration

cs-api-definition
protected override void OnScaleFactorChanged()

Overrides RadSheetEditorBase.OnScaleFactorChanged()

OnScrollBarProviderChanged()

Called when the scroll bar provider is changed.

Declaration

cs-api-definition
protected override void OnScrollBarProviderChanged()

Overrides RadSheetEditorBase.OnScrollBarProviderChanged()

OnScrollModeChanged()

Called when the scroll mode is changed.

Declaration

cs-api-definition
protected virtual void OnScrollModeChanged()

OnSheetChanged()

Raises the event.

Declaration

cs-api-definition
protected override void OnSheetChanged()

Overrides RadSheetEditorBase.OnSheetChanged()

OnSheetChanging()

Raises the event.

Declaration

cs-api-definition
protected override void OnSheetChanging()

Overrides RadSheetEditorBase.OnSheetChanging()

OpenHyperlink(HyperlinkInfo, CellIndex)

Opens the hyperlink.

Declaration

cs-api-definition
public void OpenHyperlink(HyperlinkInfo hyperlink, CellIndex cellIndex = null)

Parameters

hyperlink

HyperlinkInfo

The hyperlink.

cellIndex

CellIndex

Index of the cell.

Paste()

Pastes in the selected cells the cell values and formatting.

Declaration

cs-api-definition
public bool Paste()

Returns

bool

True if succeed.

Paste(PasteOptions)

Pastes in the selected cells respecting the specified paste options.

Declaration

cs-api-definition
public bool Paste(PasteOptions pasteOptions)

Parameters

pasteOptions

PasteOptions

The paste options.

Returns

bool

True if succeed.

PreserveSheetViewState(ISheetViewState)

Preserves the view state of the sheet.

Declaration

cs-api-definition
protected override void PreserveSheetViewState(ISheetViewState viewState)

Parameters

viewState

ISheetViewState

View state of the sheet.

Overrides RadSheetEditorBase.PreserveSheetViewState(ISheetViewState)

ReceiveWeakEvent(Type, object, EventArgs)

Receives events from the centralized event manager.

Declaration

cs-api-definition
public bool ReceiveWeakEvent(Type managerType, object sender, EventArgs e)

Parameters

managerType

Type

The type of the calling this method.

sender

object

Object that originated the event.

e

EventArgs

Event data.

Returns

bool

true if the listener handled the event. It is considered an error by the handling in WPF to register a listener for an event that the listener does not handle. Regardless, the method should return false if it receives an event that it does not recognize or handle.

RestoreHistoryState(RadWorksheetEditorHistoryState)

Restores the state of the history.

Declaration

cs-api-definition
public void RestoreHistoryState(RadWorksheetEditorHistoryState historyState)

Parameters

historyState

RadWorksheetEditorHistoryState

State of the history.

RestoreSheetViewState(ISheetViewState)

Restores the view state of the sheet.

Declaration

cs-api-definition
protected override void RestoreSheetViewState(ISheetViewState viewState)

Parameters

viewState

ISheetViewState

View state of the sheet.

Overrides RadSheetEditorBase.RestoreSheetViewState(ISheetViewState)

ResumeViewportUpdate()

Resumes the viewport update.

Declaration

cs-api-definition
public void ResumeViewportUpdate()

SetHorizontalOffset(double)

Sets the horizontal offset.

Declaration

cs-api-definition
public override void SetHorizontalOffset(double offset)

Parameters

offset

double

The offset.

Overrides RadSheetEditorBase.SetHorizontalOffset(double)

SetVerticalOffset(double)

Sets the vertical offset.

Declaration

cs-api-definition
public override void SetVerticalOffset(double offset)

Parameters

offset

double

The offset.

Overrides RadSheetEditorBase.SetVerticalOffset(double)

SuspendViewportUpdate()

Suspends the viewport update.

Declaration

cs-api-definition
public void SuspendViewportUpdate()

UnfreezePanes()

Unfreezes the panes.

Declaration

cs-api-definition
public void UnfreezePanes()

UpdateToViewWithTopLeftCellIndex(CellIndex)

Updates the view port so the top left cell index is the desired one.

Declaration

cs-api-definition
public void UpdateToViewWithTopLeftCellIndex(CellIndex cellIndex)

Parameters

cellIndex

CellIndex

The desired index of the top left visible cell.

Events

ActivePresenterChanged

Occurs when the active presenter is changed.

Declaration

cs-api-definition
public event EventHandler ActivePresenterChanged

Event Value

EventHandler

HyperlinkClicked

Occurs when a hyperlink in the document is clicked.

Declaration

cs-api-definition
public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClicked

Event Value

EventHandler<HyperlinkClickedEventArgs>

ScrollModeChanged

Occurs when the scroll mode is changed.

Declaration

cs-api-definition
public event EventHandler ScrollModeChanged

Event Value

EventHandler

In this article
DefinitionConstructorsRadWorksheetEditor()RadWorksheetEditor(SizeI)FieldsLeftMarginsPanelNameTopMarginsPanelNamePropertiesActivePresenterCommandsDialogsFrozenCellIndexHorizontalScrollModeIsHorizontalViewportUpdateSuspendedIsVerticalViewportUpdateSuspendedRadWorksheetCommandDescriptorsSelectionSheetViewportShowGridlinesShowRowColumnHeadingsTopLeftCellIndexVerticalScrollModeVisibleSizeWorksheetMethodsBringIntoView(CellIndex)CircleInvalidData()Clear(ClearType)ClearInvalidDataCircles()Copy()CreateHistoryState()Cut()Dispose()Dispose(bool)FreezePanes(CellIndex)GetCellLayoutBox(CellIndex)GetCellLayoutBox(int, int)InvalidatePresenterLayout()MeasureOverride(Size)OnActivePresenterChanged()OnApplyTemplate()OnGotFocus(RoutedEventArgs)OnHyperlinkClicked(HyperlinkClickedEventArgs)OnInitialized(EventArgs)OnOwnerChanged()OnOwnerChanging()OnPreviewKeyDown(KeyEventArgs)OnScaleFactorChanged()OnScrollBarProviderChanged()OnScrollModeChanged()OnSheetChanged()OnSheetChanging()OpenHyperlink(HyperlinkInfo, CellIndex)Paste()Paste(PasteOptions)PreserveSheetViewState(ISheetViewState)ReceiveWeakEvent(Type, object, EventArgs)RestoreHistoryState(RadWorksheetEditorHistoryState)RestoreSheetViewState(ISheetViewState)ResumeViewportUpdate()SetHorizontalOffset(double)SetVerticalOffset(double)SuspendViewportUpdate()UnfreezePanes()UpdateToViewWithTopLeftCellIndex(CellIndex)EventsActivePresenterChangedHyperlinkClickedScrollModeChanged
Not finding the help you need?
Contact Support