Class RadWorksheetEditor

Represents a visual editor for a spreadsheet worksheet that provides user interface capabilities for editing, selection, and navigation within the worksheet data.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIElement
ControlBase
RadSheetEditorBase
RadSheetEditorBase<Worksheet>
RadWorksheetEditor
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinForms.Controls.Spreadsheet.Worksheets
Assembly: Telerik.WinControls.RadSpreadsheet.dll

Syntax

public class RadWorksheetEditor : RadSheetEditorBase<Worksheet>, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IRadSheetEditor, ICommandDescriptorsProvider, ISheetEditor, IWorksheetUILayerOwner, IUILayerOwner, IDisposable

Constructors

RadWorksheetEditor(RadSpreadsheetElement)

Initializes a new instance of the RadWorksheetEditor class with default visible size and the specified owner.

Declaration
public RadWorksheetEditor(RadSpreadsheetElement owner)
Parameters
RadSpreadsheetElement owner

The RadSpreadsheetElement that owns this worksheet editor.

RadWorksheetEditor(SizeI, RadSpreadsheetElement)

Initializes a new instance of the RadWorksheetEditor class with the specified visible size and owner.

Declaration
public RadWorksheetEditor(SizeI visibleSize, RadSpreadsheetElement owner)
Parameters
SizeI visibleSize

The dimensions of the visible area for the worksheet editor.
RadSpreadsheetElement owner

The RadSpreadsheetElement that owns this worksheet editor.

Fields

LeftMarginsPanelName

The name identifier for the left margins panel within the worksheet editor layout.

Declaration
public static readonly string LeftMarginsPanelName
Field Value
System.String

TopMarginsPanelName

The name identifier for the top margins panel within the worksheet editor layout.

Declaration
public static readonly string TopMarginsPanelName
Field Value
System.String

Properties

ActivePresenter

Gets the currently active presenter responsible for rendering the worksheet content.

Declaration
public IRadWorksheetEditorPresenter ActivePresenter { get; }
Property Value
IRadWorksheetEditorPresenter

Commands

Gets the collection of commands available for worksheet editing operations.

Declaration
public RadWorksheetEditorCommands Commands { get; }
Property Value
RadWorksheetEditorCommands

Dialogs

Gets the dialog management system for worksheet editor operations.

Declaration
public WorksheetEditorDialogs Dialogs { get; }
Property Value
WorksheetEditorDialogs

FrozenCellIndex

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

Declaration
public CellIndex FrozenCellIndex { get; }
Property Value
CellIndex

HorizontalScrollMode

Gets or sets the horizontal scrolling behavior for the worksheet editor.

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

IsHorizontalViewportUpdateSuspended

Gets a value indicating whether horizontal viewport updates are currently suspended.

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

IsVerticalViewportUpdateSuspended

Gets a value indicating whether vertical viewport updates are currently suspended.

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

Selection

Gets the current cell and range selection within the worksheet.

Declaration
public Selection Selection { get; }
Property Value
Selection

SheetViewport

Gets the viewport information for the currently displayed portion of the worksheet.

Declaration
public override SheetViewport SheetViewport { get; }
Property Value
SheetViewport

Overrides

ShowGridlines

Gets or sets a value indicating whether gridlines are displayed in the worksheet.

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

ShowRowColumnHeadings

Gets or sets a value indicating whether row and column headings are displayed in the worksheet.

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

TopLeftCellIndex

Gets the cell index of the top-left visible cell in the current view.

Declaration
public CellIndex TopLeftCellIndex { get; }
Property Value
CellIndex

VerticalScrollMode

Gets or sets the vertical scrolling behavior for the worksheet editor.

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

VisibleSize

Gets the dimensions of the visible area within the worksheet editor.

Declaration
public SizeI VisibleSize { get; }
Property Value
SizeI

Worksheet

Gets or sets the Worksheet instance being edited by this worksheet editor.

Declaration
public Worksheet Worksheet { get; set; }
Property Value
Worksheet

Methods

ArrangeOverride(SizeF)

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

Returns
System.Drawing.SizeF

Overrides

BringIntoView(CellIndex)

Scrolls the worksheet view to ensure the specified cell is visible within the current viewport.

Declaration
public void BringIntoView(CellIndex cellIndex)
Parameters
CellIndex cellIndex

The cell index to bring into view.

CircleInvalidData()

Displays visual circles around cells containing invalid data according to data validation rules.

Declaration
public void CircleInvalidData()

Clear(ClearType)

Clears the selected cells.

Declaration
public void Clear(ClearType clearType)
Parameters
ClearType clearType

Type of the clear.

ClearInvalidDataCircles()

Removes the visual circles that mark cells with invalid data.

Declaration
public void ClearInvalidDataCircles()

Copy()

Copies the selected cell values and formatting.

Declaration
public bool Copy()
Returns
System.Boolean

True if succeed.

CreateHistoryState()

Creates a snapshot of the current worksheet editor state for history tracking purposes.

Declaration
public RadWorksheetEditorHistoryState CreateHistoryState()
Returns
RadWorksheetEditorHistoryState

A RadWorksheetEditorHistoryState representing the current state.

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()
Implements
System.IDisposable.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.

DisposeManagedResources()

Declaration
protected override void DisposeManagedResources()
Overrides

FreezePanes(CellIndex)

Freezes the worksheet panes at the specified cell position, creating fixed rows and columns.

Declaration
public void FreezePanes(CellIndex cellIndex)
Parameters
CellIndex cellIndex

The cell index where the freeze should occur.

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
CellLayoutBox

The cell layout box.

GetCellLayoutBox(CellIndex)

Gets the cell layout box.

Declaration
public CellLayoutBox GetCellLayoutBox(CellIndex cellIndex)
Parameters
CellIndex cellIndex

Index of the cell.
Returns
CellLayoutBox

The cell layout box.

InvalidatePresenterLayout()

Invalidates the presenter layout.

Declaration
public void InvalidatePresenterLayout()

MeasureOverride(SizeF)

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 SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF 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.Drawing.SizeF

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

OnActivePresenterChanged()

Raises the ActivePresenterChanged event.

Declaration
protected virtual void OnActivePresenterChanged()

OnFilterMenuOpened(FilterMenuPopupOpenedEventArgs)

Raises the FilterMenuOpened event.

Declaration
protected virtual void OnFilterMenuOpened(FilterMenuPopupOpenedEventArgs args)
Parameters
FilterMenuPopupOpenedEventArgs args

The event arguments containing opened filter menu information.

OnFilterMenuOpening(FilterMenuPopupOpeningEventArgs)

Raises the FilterMenuOpening event.

Declaration
protected virtual void OnFilterMenuOpening(FilterMenuPopupOpeningEventArgs args)
Parameters
FilterMenuPopupOpeningEventArgs args

The event arguments containing filter menu information.

OnHyperlinkClicked(HyperlinkClickedEventArgs)

Raises the HyperlinkClicked event.

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

The event arguments containing hyperlink information.

OnOwnerChanged()

Called when the owner is changed.

Declaration
protected override void OnOwnerChanged()
Overrides

OnOwnerChanging()

Raises the OwnerChanging event.

Declaration
protected override void OnOwnerChanging()
Overrides

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

Raises the ScrollModeChanged event.

Declaration
protected virtual void OnScrollModeChanged()

OnSheetChanged()

Called when the worksheet has changed, setting up event handlers and initializing the new worksheet.

Declaration
protected override void OnSheetChanged()
Overrides

OnSheetChanging()

Called when the worksheet is about to change, allowing for cleanup of event handlers and resources.

Declaration
protected override void OnSheetChanging()
Overrides

OpenHyperlink(HyperlinkInfo)

Opens and navigates to the specified hyperlink.

Declaration
public void OpenHyperlink(HyperlinkInfo hyperlink)
Parameters
HyperlinkInfo hyperlink

The hyperlink information to open.

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
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
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 worksheet editor to a previously saved history state.

Declaration
public void RestoreHistoryState(RadWorksheetEditorHistoryState historyState)
Parameters
RadWorksheetEditorHistoryState historyState

The history state to restore.

RestoreSheetViewState(ISheetViewState)

Restores the view state of the sheet.

Declaration
protected override void RestoreSheetViewState(ISheetViewState viewState)
Parameters
ISheetViewState viewState

View state of the sheet.
Overrides

ResumeViewportUpdate()

Resumes viewport updates that were previously suspended by SuspendViewportUpdate().

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

ShouldArrangeChild(RadElement)

Declaration
protected override bool ShouldArrangeChild(RadElement child)
Parameters
RadElement child

Returns
System.Boolean

Overrides

ShouldMeasureChild(RadElement)

Declaration
protected override bool ShouldMeasureChild(RadElement child)
Parameters
RadElement child

Returns
System.Boolean

Overrides

SuspendViewportUpdate()

Temporarily suspends viewport updates to improve performance during multiple operations.

Declaration
public void SuspendViewportUpdate()

UnfreezePanes()

Removes any frozen panes from the worksheet, allowing all rows and columns to scroll freely.

Declaration
public void UnfreezePanes()

UpdateToViewWithTopLeftCellIndex(CellIndex)

Updates the viewport to position the specified cell as the top-left visible cell.

Declaration
public void UpdateToViewWithTopLeftCellIndex(CellIndex cellIndex)
Parameters
CellIndex cellIndex

The cell index to position at the top-left of the viewport.

Events

ActivePresenterChanged

Occurs when the active presenter changes to a different worksheet presenter implementation.

Declaration
public event EventHandler ActivePresenterChanged
Event Type
System.EventHandler

FilterMenuOpened

Occurs when a filter menu popup has been opened and is displayed to the user.

Declaration
public event FilterMenuPopupOpenedEventHandler FilterMenuOpened
Event Type
FilterMenuPopupOpenedEventHandler

FilterMenuOpening

Occurs when a filter menu popup is about to open, allowing for customization of the filter options.

Declaration
public event FilterMenuPopupOpeningEventHandler FilterMenuOpening
Event Type
FilterMenuPopupOpeningEventHandler

HyperlinkClicked

Occurs when a hyperlink within a worksheet cell is clicked by the user.

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

ScrollModeChanged

Occurs when the horizontal or vertical scroll mode changes.

Declaration
public event EventHandler ScrollModeChanged
Event Type
System.EventHandler

Extension Methods