RadWorksheetEditor
Represents the RadWorksheetEditor.
Definition
Namespace:Telerik.Windows.Controls.Spreadsheet.Worksheets
Assembly:Telerik.Windows.Controls.Spreadsheet.dll
Syntax:
public class RadWorksheetEditor : RadSheetEditorBase<Worksheet>, IRadSheetEditor, ICommandDescriptorsProvider, ISheetEditor, IUILayerOwner, IDisposable, IWeakEventListenerInheritance: objectControlBaseRadSheetEditorBaseRadSheetEditorBase<Worksheet>RadWorksheetEditor
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadWorksheetEditor class.
public RadWorksheetEditor()Initializes a new instance of the RadWorksheetEditor class.
public RadWorksheetEditor(SizeI visibleSize)Size of the visible.
Fields
Left margins panel name.
public static readonly string LeftMarginsPanelNameTop margins panel name.
public static readonly string TopMarginsPanelNameProperties
Gets the active presenter.
public IRadWorksheetEditorPresenter ActivePresenter { get; }The active presenter.
Gets the commands.
public RadWorksheetEditorCommands Commands { get; }The commands.
Gets the dialogs.
public WorksheetEditorDialogs Dialogs { get; }The dialogs.
FrozenCellIndex
CellIndex
Gets the index of the cell below the top frozen pane and to the right of the left frozen pane.
public CellIndex FrozenCellIndex { get; }The index of the frozen cell.
Gets or sets the horizontal scroll mode.
public ScrollMode HorizontalScrollMode { get; set; }The horizontal scroll mode.
Gets the value indicating if the horizontal viewport update is suspended.
public bool IsHorizontalViewportUpdateSuspended { get; }The value indicating if the horizontal viewport update is suspended.
Gets the value indicating if the vertical viewport update is suspended.
public bool IsVerticalViewportUpdateSuspended { get; }The value indicating if the vertical viewport update is suspended.
Allows you to get or set the command descriptors. Used when overriding the default command descriptors with custom ones.
public CommandDescriptors RadWorksheetCommandDescriptors { get; set; }Gets the selection.
public Selection Selection { get; }The selection.
SheetViewport
SheetViewport
Gets the sheet viewport.
public override SheetViewport SheetViewport { get; }The sheet viewport.
Overrides:
Gets or sets a value indicating whether to show gridlines.
public bool ShowGridlines { get; set; }The value indicating whether to show gridlines.
Gets or sets a value indicating whether to show row and column headings.
public bool ShowRowColumnHeadings { get; set; }The value indicating whether to show row and column headings.
TopLeftCellIndex
CellIndex
Gets the index of the top left cell.
public CellIndex TopLeftCellIndex { get; }The index of the top left cell.
Gets or sets the vertical scroll mode.
public ScrollMode VerticalScrollMode { get; set; }The vertical scroll mode.
VisibleSize
SizeI
Gets the size of the visible.
public SizeI VisibleSize { get; }The size of the visible.
Worksheet
Worksheet
Gets or sets the worksheet.
public Worksheet Worksheet { get; set; }The worksheet.
Methods
Brings the into view.
public void BringIntoView(CellIndex cellIndex)Index of the cell.
Circles the invalid data.
public void CircleInvalidData()Clears the selected cells.
public void Clear(ClearType clearType)Type of the clear.
Clears the invalid data circles.
public void ClearInvalidDataCircles()Copies the selected cell values and formatting.
Creates the state of the history.
public RadWorksheetEditorHistoryState CreateHistoryState()RadWorksheetEditorHistoryState
The state of the history.
Cuts the selected cell values and formatting.
public void Cut()Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
public void Dispose()Implements:
Disposes the specified clean up managed resources.
protected virtual void Dispose(bool cleanUpManagedResources)The clean up managed resources.
Freezes the panes.
public void FreezePanes(CellIndex cellIndex)Index of the cell.
GetCellLayoutBox(CellIndex)
CellLayoutBox
Gets the cell layout box.
public CellLayoutBox GetCellLayoutBox(CellIndex cellIndex)Index of the cell.
Returns:CellLayoutBox
The cell layout box.
GetCellLayoutBox(int, int)
CellLayoutBox
Invalidates the presenter layout.
public void InvalidatePresenterLayout()When overridden in a derived class, measures the size in layout required for child elements and determines a size for the FrameworkElement-derived class.
protected override Size MeasureOverride(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:Size
The size that this element determines it needs during layout, based on its calculations of child element sizes.
Called when the active presenter is changed.
protected virtual void OnActivePresenterChanged()When overridden in a derived class, is invoked whenever application code or internal processes call .
public override void OnApplyTemplate()Raises the routed event by using the event data provided.
protected override void OnGotFocus(RoutedEventArgs e)A RoutedEventArgs that contains event data. This event data must contain the identifier for the event.
Called when a hyperlink in the document is clicked.
protected virtual void OnHyperlinkClicked(HyperlinkClickedEventArgs args)Raises the event. This method is invoked whenever is set to true internally.
protected override void OnInitialized(EventArgs e)The RoutedEventArgs that contains the event data.
Called when the owner is changed.
protected override void OnOwnerChanged()Overrides:
Raises the event.
protected override void OnOwnerChanging()Overrides:
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.
protected override void OnPreviewKeyDown(KeyEventArgs e)The KeyEventArgs that contains the event data.
Raises the event.
protected override void OnScaleFactorChanged()Overrides:
Called when the scroll bar provider is changed.
protected override void OnScrollBarProviderChanged()Overrides:
Called when the scroll mode is changed.
protected virtual void OnScrollModeChanged()Raises the event.
protected override void OnSheetChanged()Overrides:
Raises the event.
protected override void OnSheetChanging()Overrides:
Opens the hyperlink.
public void OpenHyperlink(HyperlinkInfo hyperlink, CellIndex cellIndex = null)The hyperlink.
cellIndexCellIndexIndex of the cell.
Pastes in the selected cells the cell values and formatting.
Pastes in the selected cells respecting the specified paste options.
public bool Paste(PasteOptions pasteOptions)The paste options.
Returns:True if succeed.
Preserves the view state of the sheet.
protected override void PreserveSheetViewState(ISheetViewState viewState)View state of the sheet.
Overrides:
Receives events from the centralized event manager.
public bool ReceiveWeakEvent(Type managerType, object sender, EventArgs e)The type of the calling this method.
senderobjectObject that originated the event.
eEventArgsEvent data.
Returns: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.
Restores the state of the history.
public void RestoreHistoryState(RadWorksheetEditorHistoryState historyState)State of the history.
Restores the view state of the sheet.
protected override void RestoreSheetViewState(ISheetViewState viewState)View state of the sheet.
Overrides:
Resumes the viewport update.
public void ResumeViewportUpdate()Sets the horizontal offset.
public override void SetHorizontalOffset(double offset)The offset.
Overrides:
Sets the vertical offset.
public override void SetVerticalOffset(double offset)The offset.
Overrides:
Suspends the viewport update.
public void SuspendViewportUpdate()Unfreezes the panes.
public void UnfreezePanes()Updates the view port so the top left cell index is the desired one.
public void UpdateToViewWithTopLeftCellIndex(CellIndex cellIndex)The desired index of the top left visible cell.
Events
Occurs when the active presenter is changed.
public event EventHandler ActivePresenterChangedOccurs when a hyperlink in the document is clicked.
public event EventHandler<HyperlinkClickedEventArgs> HyperlinkClickedOccurs when the scroll mode is changed.
public event EventHandler ScrollModeChanged