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.

Declaration

public RadWorksheetEditor(RadSpreadsheetElement owner)

Parameters

RadSpreadsheetElement owner

RadWorksheetEditor(SizeI, RadSpreadsheetElement)

Initializes a new instance of the RadWorksheetEditor class.

Declaration

public RadWorksheetEditor(SizeI visibleSize, RadSpreadsheetElement owner)

Parameters

SizeI visibleSize Size of the visible.
RadSpreadsheetElement owner The owner RadSpreadsheetElement of this worksheet.

Fields

LeftMarginsPanelName

Left martgins 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

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.

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

SheetViewport The sheet viewport.

Overrides

RadSheetEditorBase.SheetViewport

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

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

SizeI The size of the visible.

Worksheet

Gets or sets the worksheet.

Declaration

public Worksheet Worksheet { get; set; }

Property Value

Worksheet The worksheet.

Methods

ArrangeOverride(SizeF)

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

System.Drawing.SizeF finalSize

Returns

System.Drawing.SizeF

Overrides

RadElement.ArrangeOverride(SizeF)

BringIntoView(CellIndex)

Brings the into view.

Declaration

public void BringIntoView(CellIndex cellIndex)

Parameters

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

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

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

RadItem.DisposeManagedResources()

FreezePanes(CellIndex)

Freezes the panes.

Declaration

public void FreezePanes(CellIndex cellIndex)

Parameters

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

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

RadElement.MeasureOverride(SizeF)

OnActivePresenterChanged()

Called when the active presenter is changed.

Declaration

protected virtual void OnActivePresenterChanged()

OnFilterMenuOpened(FilterMenuPopupOpenedEventArgs)

Declaration

protected virtual void OnFilterMenuOpened(FilterMenuPopupOpenedEventArgs args)

Parameters

FilterMenuPopupOpenedEventArgs args

OnFilterMenuOpening(FilterMenuPopupOpeningEventArgs)

Declaration

protected virtual void OnFilterMenuOpening(FilterMenuPopupOpeningEventArgs args)

Parameters

FilterMenuPopupOpeningEventArgs args

OnHyperlinkClicked(HyperlinkClickedEventArgs)

Called when a hyperlink in the document is clicked.

Declaration

protected virtual void OnHyperlinkClicked(HyperlinkClickedEventArgs args)

Parameters

HyperlinkClickedEventArgs args

OnOwnerChanged()

Called when the owner is changed.

Declaration

protected override void OnOwnerChanged()

Overrides

RadSheetEditorBase.OnOwnerChanged()

OnOwnerChanging()

Raises the OwnerChanging event.

Declaration

protected override void OnOwnerChanging()

Overrides

RadSheetEditorBase.OnOwnerChanging()

OnScaleFactorChanged()

Raises the ScaleFactorChanged event.

Declaration

protected override void OnScaleFactorChanged()

Overrides

RadSheetEditorBase.OnScaleFactorChanged()

OnScrollBarProviderChanged()

Called when the scroll bar provider is changed.

Declaration

protected override void OnScrollBarProviderChanged()

Overrides

RadSheetEditorBase.OnScrollBarProviderChanged()

OnScrollModeChanged()

Called when the scroll mode is changed.

Declaration

protected virtual void OnScrollModeChanged()

OnSheetChanged()

Raises the SheetChanged event.

Declaration

protected override void OnSheetChanged()

Overrides

RadSheetEditorBase.OnSheetChanged()

OnSheetChanging()

Raises the SheetChanging event.

Declaration

protected override void OnSheetChanging()

Overrides

RadSheetEditorBase.OnSheetChanging()

OpenHyperlink(HyperlinkInfo)

Opens the hyperlink.

Declaration

public void OpenHyperlink(HyperlinkInfo hyperlink)

Parameters

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

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

RadSheetEditorBase.PreserveSheetViewState(ISheetViewState)

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

ISheetViewState viewState View state of the sheet.

Overrides

RadSheetEditorBase.RestoreSheetViewState(ISheetViewState)

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

RadSheetEditorBase.SetHorizontalOffset(Double)

SetVerticalOffset(Double)

Sets the vertical offset.

Declaration

public override void SetVerticalOffset(double offset)

Parameters

System.Double offset The offset.

Overrides

RadSheetEditorBase.SetVerticalOffset(Double)

ShouldArrangeChild(RadElement)

Declaration

protected override bool ShouldArrangeChild(RadElement child)

Parameters

RadElement child

Returns

System.Boolean

Overrides

RadElement.ShouldArrangeChild(RadElement)

ShouldMeasureChild(RadElement)

Declaration

protected override bool ShouldMeasureChild(RadElement child)

Parameters

RadElement child

Returns

System.Boolean

Overrides

RadElement.ShouldMeasureChild(RadElement)

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

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

FilterMenuOpened

Declaration

public event FilterMenuPopupOpenedEventHandler FilterMenuOpened

Event Type

FilterMenuPopupOpenedEventHandler

FilterMenuOpening

Declaration

public event FilterMenuPopupOpeningEventHandler FilterMenuOpening

Event Type

FilterMenuPopupOpeningEventHandler

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

CommonExtensions.ClearIfNoBindingAndSet(RadObject, RadProperty)

DispatcherExtensions.CheckAccess(RadObject)

SerializationExtensions.DeserializePrimitives(RadItem, SerializationInfo)

CommonExtensions.SetIfDifferent(RadObject, RadProperty, Object)

CommonExtensions.ClearIfSet(RadObject, RadProperty)

CommonExtensions.IsLocalValueSet(RadObject, RadProperty)

DispatcherExtensions.CheckAccess(RadObject)

SvgExtentions.Traverse<T>(T, Func<T, IEnumerable<T>>)

SvgExtentions.TraverseDepthFirst<T>(T, Func<T, IEnumerable<T>>)