Class RadWorksheetEditor

Represents the RadWorksheetEditor.

Inheritance
System.Object
ControlBase
RadSheetEditorBase
RadSheetEditorBase<Telerik.Windows.Documents.Spreadsheet.Model.Worksheet>
RadWorksheetEditor
Inherited Members
Namespace: Telerik.Windows.Controls.Spreadsheet.Worksheets
Assembly: Telerik.Windows.Controls.Spreadsheet.dll

Syntax

public class RadWorksheetEditor : RadSheetEditorBase<Worksheet>, IRadSheetEditor, ICommandDescriptorsProvider, ISheetEditor, IWorksheetUILayerOwner, IUILayerOwner, IDisposable, IWeakEventListener

Constructors

RadWorksheetEditor()

Initializes a new instance of the RadWorksheetEditor class.

Declaration
public RadWorksheetEditor()

RadWorksheetEditor(SizeI)

Initializes a new instance of the RadWorksheetEditor class.

Declaration
public RadWorksheetEditor(SizeI visibleSize)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.SizeI visibleSize

Size of the visible.

Fields

LeftMarginsPanelName

Left margins panel name.

Declaration
public static readonly string LeftMarginsPanelName
Field Value
System.String

TopMarginsPanelName

Top margins panel name.

Declaration
public static readonly string TopMarginsPanelName
Field Value
System.String

Properties

ActivePresenter

Gets the active presenter.

Declaration
public IRadWorksheetEditorPresenter ActivePresenter { get; }
Property Value
IRadWorksheetEditorPresenter

The active presenter.

Commands

Gets the commands.

Declaration
public RadWorksheetEditorCommands Commands { get; }
Property Value
RadWorksheetEditorCommands

The commands.

Dialogs

Gets the dialogs.

Declaration
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
public CellIndex FrozenCellIndex { get; }
Property Value
Telerik.Windows.Documents.Spreadsheet.Model.CellIndex

The index of the frozen cell.

HorizontalScrollMode

Gets or sets the horizontal scroll mode.

Declaration
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
public bool IsHorizontalViewportUpdateSuspended { get; }
Property Value
System.Boolean

The value indicating if the horizontal viewport update is suspended.

IsVerticalViewportUpdateSuspended

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

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

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
public CommandDescriptors RadWorksheetCommandDescriptors { get; set; }
Property Value
CommandDescriptors

Selection

Gets the selection.

Declaration
public Selection Selection { get; }
Property Value
Selection

The selection.

SheetViewport

Gets the sheet viewport.

Declaration
public override SheetViewport SheetViewport { get; }
Property Value
Telerik.Windows.Documents.Spreadsheet.Layout.SheetViewport

The sheet viewport.
Overrides

ShowGridlines

Gets or sets a value indicating whether to show gridlines.

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

The value indicating whether to show gridlines.

ShowRowColumnHeadings

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

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

The value indicating whether to show row and column headings.

TopLeftCellIndex

Gets the index of the top left cell.

Declaration
public CellIndex TopLeftCellIndex { get; }
Property Value
Telerik.Windows.Documents.Spreadsheet.Model.CellIndex

The index of the top left cell.

VerticalScrollMode

Gets or sets the vertical scroll mode.

Declaration
public ScrollMode VerticalScrollMode { get; set; }
Property Value
ScrollMode

The vertical scroll mode.

VisibleSize

Gets the size of the visible.

Declaration
public SizeI VisibleSize { get; }
Property Value
Telerik.Windows.Documents.Spreadsheet.Model.SizeI

The size of the visible.

Worksheet

Gets or sets the worksheet.

Declaration
public Worksheet Worksheet { get; set; }
Property Value
Telerik.Windows.Documents.Spreadsheet.Model.Worksheet

The worksheet.

Methods

BringIntoView(CellIndex)

Brings the into view.

Declaration
public void BringIntoView(CellIndex cellIndex)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.CellIndex cellIndex

Index of the cell.

CircleInvalidData()

Circles the invalid data.

Declaration
public void CircleInvalidData()

Clear(ClearType)

Clears the selected cells.

Declaration
public void Clear(ClearType clearType)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.ClearType clearType

Type of the clear.

ClearInvalidDataCircles()

Clears the invalid data circles.

Declaration
public void ClearInvalidDataCircles()

Copy()

Copies the selected cell values and formatting.

Declaration
public bool Copy()
Returns
System.Boolean

True if succeed.

CreateHistoryState()

Creates the state of the history.

Declaration
public RadWorksheetEditorHistoryState CreateHistoryState()
Returns
RadWorksheetEditorHistoryState

The state of the history.

Cut()

Cuts the selected cell values and formatting.

Declaration
public void Cut()

Dispose()

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

Declaration
public void Dispose()

Dispose(Boolean)

Disposes the specified clean up managed resources.

Declaration
protected virtual void Dispose(bool cleanUpManagedResources)
Parameters
System.Boolean cleanUpManagedResources

The clean up managed resources.

FreezePanes(CellIndex)

Freezes the panes.

Declaration
public void FreezePanes(CellIndex cellIndex)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.CellIndex cellIndex

Index of the cell.

GetCellLayoutBox(Int32, Int32)

Gets the cell layout box.

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

Index of the row.
System.Int32 columnIndex

Index of the column.
Returns
Telerik.Windows.Documents.Spreadsheet.Layout.CellLayoutBox

The cell layout box.

GetCellLayoutBox(CellIndex)

Gets the cell layout box.

Declaration
public CellLayoutBox GetCellLayoutBox(CellIndex cellIndex)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.CellIndex cellIndex

Index of the cell.
Returns
Telerik.Windows.Documents.Spreadsheet.Layout.CellLayoutBox

The cell layout box.

InvalidatePresenterLayout()

Invalidates the presenter layout.

Declaration
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 System.Windows.FrameworkElement-derived class.

Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
System.Windows.Size availableSize

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
System.Windows.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
protected virtual void OnActivePresenterChanged()

OnApplyTemplate()

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

Declaration
public override void OnApplyTemplate()

OnGotFocus(RoutedEventArgs)

Raises the System.Windows.UIElement.GotFocus routed event by using the event data provided.

Declaration
protected override void OnGotFocus(RoutedEventArgs e)
Parameters
System.Windows.RoutedEventArgs e

A System.Windows.RoutedEventArgs that contains event data. This event data must contain the identifier for the System.Windows.UIElement.GotFocus event.

OnHyperlinkClicked(HyperlinkClickedEventArgs)

Called when a hyperlink in the document is clicked.

Declaration
protected virtual void OnHyperlinkClicked(HyperlinkClickedEventArgs args)
Parameters
HyperlinkClickedEventArgs args

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

OnOwnerChanged()

Called when the owner is changed.

Declaration
protected override void OnOwnerChanged()
Overrides

OnOwnerChanging()

Raises the OwnerChanging event.

Declaration
protected override void OnOwnerChanging()
Overrides

OnPreviewKeyDown(KeyEventArgs)

Invoked when an unhandled System.Windows.Input.Keyboard.PreviewKeyDown 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
protected override void OnPreviewKeyDown(KeyEventArgs e)
Parameters
System.Windows.Input.KeyEventArgs e

The System.Windows.Input.KeyEventArgs that contains the event data.

OnScaleFactorChanged()

Raises the ScaleFactorChanged event.

Declaration
protected override void OnScaleFactorChanged()
Overrides

OnScrollBarProviderChanged()

Called when the scroll bar provider is changed.

Declaration
protected override void OnScrollBarProviderChanged()
Overrides

OnScrollModeChanged()

Called when the scroll mode is changed.

Declaration
protected virtual void OnScrollModeChanged()

OnSheetChanged()

Raises the SheetChanged event.

Declaration
protected override void OnSheetChanged()
Overrides

OnSheetChanging()

Raises the SheetChanging event.

Declaration
protected override void OnSheetChanging()
Overrides

OpenHyperlink(HyperlinkInfo)

Opens the hyperlink.

Declaration
public void OpenHyperlink(HyperlinkInfo hyperlink)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.HyperlinkInfo hyperlink

The hyperlink.

Paste()

Pastes in the selected cells the cell values and formatting.

Declaration
public bool Paste()
Returns
System.Boolean

True if succeed.

Paste(PasteOptions)

Pastes in the selected cells respecting the specified paste options.

Declaration
public bool Paste(PasteOptions pasteOptions)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.PasteOptions pasteOptions

The paste options.
Returns
System.Boolean

True if succeed.

PreserveSheetViewState(ISheetViewState)

Preserves the view state of the sheet.

Declaration
protected override void PreserveSheetViewState(ISheetViewState viewState)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.ISheetViewState viewState

View state of the sheet.
Overrides

ReceiveWeakEvent(Type, Object, EventArgs)

Receives events from the centralized event manager.

Declaration
public bool ReceiveWeakEvent(Type managerType, object sender, EventArgs e)
Parameters
System.Type managerType

The type of the System.Windows.WeakEventManager calling this method.
System.Object sender

Object that originated the event.
System.EventArgs e

Event data.
Returns
System.Boolean

true if the listener handled the event. It is considered an error by the System.Windows.WeakEventManager 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
public void RestoreHistoryState(RadWorksheetEditorHistoryState historyState)
Parameters
RadWorksheetEditorHistoryState historyState

State of the history.

RestoreSheetViewState(ISheetViewState)

Restores the view state of the sheet.

Declaration
protected override void RestoreSheetViewState(ISheetViewState viewState)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.ISheetViewState viewState

View state of the sheet.
Overrides

ResumeViewportUpdate()

Resumes the viewport update.

Declaration
public void ResumeViewportUpdate()

SetHorizontalOffset(Double)

Sets the horizontal offset.

Declaration
public override void SetHorizontalOffset(double offset)
Parameters
System.Double offset

The offset.
Overrides

SetVerticalOffset(Double)

Sets the vertical offset.

Declaration
public override void SetVerticalOffset(double offset)
Parameters
System.Double offset

The offset.
Overrides

SuspendViewportUpdate()

Suspends the viewport update.

Declaration
public void SuspendViewportUpdate()

UnfreezePanes()

Unfreezes the panes.

Declaration
public void UnfreezePanes()

UpdateToViewWithTopLeftCellIndex(CellIndex)

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

Declaration
public void UpdateToViewWithTopLeftCellIndex(CellIndex cellIndex)
Parameters
Telerik.Windows.Documents.Spreadsheet.Model.CellIndex cellIndex

The desired index of the top left visible cell.

Events

ActivePresenterChanged

Occurs when the active presenter is changed.

Declaration
public event EventHandler ActivePresenterChanged
Event Type
System.EventHandler

HyperlinkClicked

Occurs when a hyperlink in the document is clicked.

Declaration
public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClicked
Event Type
System.EventHandler<HyperlinkClickedEventArgs>

ScrollModeChanged

Occurs when the scroll mode is changed.

Declaration
public event EventHandler ScrollModeChanged
Event Type
System.EventHandler

Extension Methods