New to Telerik UI for WinForms? Start a free 30-day trial

RedockService

Class

Represents a service that allows a DockWindow state to be saved and restored later on.

Definition

Namespace:Telerik.WinControls.UI.Docking

Assembly:Telerik.WinControls.RadDock.dll

Syntax:

public class RedockService : RadDockService, IDisposable, INotifyPropertyChanged, INotifyPropertyChangingEx

Inheritance: objectRadDockObjectRadDockServiceRedockService

Implements: IDisposableINotifyPropertyChangedINotifyPropertyChangingEx

Inherited Members RadDockService.OnDockManagerChanged()RadDockService.OnEnabledChanged()RadDockService.CanOperate()RadDockService.DockManagerDesignModeRadDockService.DockManagerRadDockService.EnabledRadDockObject.Dispose()RadDockObject.Dispose(bool)RadDockObject.DisposeManagedResources()RadDockObject.DisposeUnmanagedResources()RadDockObject.OnPropertyChanging(string)RadDockObject.OnPropertyChanged(string)RadDockObject.ShouldSerializeProperty(string)RadDockObject.EventsRadDockObject.DisposingRadDockObject.IsDisposedRadDockObject.DisposedRadDockObject.PropertyChangingRadDockObject.PropertyChanged...

Constructors

RedockService()

Default constructor.

public RedockService()

Properties

IsCleanUpSuspended

bool

Determines whether clean-up is currently suspended.

public bool IsCleanUpSuspended { get; }

StatesForCleanup

RedockState[]

Gets an array with all the states that are currently marked for clean-up.

protected RedockState[] StatesForCleanup { get; }

Methods

CleanUp()

Removes previous redock states which are no longer valid. For example, if we save a state for a dock window in a Docked state, we need to remove any previous redock state for the Docked state.

public void CleanUp()

ClearAllStates(DockWindow)

Removes all the redock states saved for the specified window.

public void ClearAllStates(DockWindow window)

Parameters:windowDockWindow

ClearState(DockWindow, DockState)

Removes previously saved redock state for the specified window for the specified DockState.

public bool ClearState(DockWindow window, DockState dockState)

Parameters:windowDockWindowdockStateDockStateReturns:

bool

GetNewDockState(DockState)

Retrieves the new DockState for a redock operation, depending on the provided current DockState.

public static DockState GetNewDockState(DockState currState)

Parameters:currStateDockStateReturns:

DockState

GetState(DockWindow, DockState, bool)

Gets a RedockState instance for the specified window and DockState.

protected RedockState GetState(DockWindow window, DockState state, bool remove)

Parameters:windowDockWindow

The window for which to look-up a state.

stateDockState

The DockState to look-up for.

removebool

True to remove the redock state from the list, false otherwise.

Returns:

RedockState

IsSaveApplicable(DockWindow)

Determines whether a Save operation is applicable for the specified window. Currently supported states are Docked and Floating.

public bool IsSaveApplicable(DockWindow window)

Parameters:windowDockWindowReturns:

bool

Redock(DockWindow, bool)

public void Redock(DockWindow window, bool defaultAction)

Parameters:windowDockWindowdefaultActionbool

Redock(DockWindow, RedockTransactionReason, bool)

Performs a redock operation upon specified window.

public void Redock(DockWindow window, RedockTransactionReason reason, bool defaultAction)

Parameters:windowDockWindowreasonRedockTransactionReasondefaultActionbool

True to perform default action if no state is recorded for a window, false otherwise.

Redock(IEnumerable<DockWindow>, bool)

Performs a redock operation upon specified windows.

public void Redock(IEnumerable<DockWindow> windows, bool defaultAction)

Parameters:windowsIEnumerable<DockWindow>defaultActionbool

True to perform default action if no state is recorded for a window, false otherwise.

Redock(IEnumerable<DockWindow>, RedockTransactionReason, bool)

Performs a redock operation upon specified windows.

public void Redock(IEnumerable<DockWindow> windows, RedockTransactionReason reason, bool defaultAction)

Parameters:windowsIEnumerable<DockWindow>reasonRedockTransactionReasondefaultActionbool

True to perform default action if no state is recorded for a window, false otherwise.

RemovePreviousState(RedockState)

Releases previous redock state. Current implementation simply notifies the referenced DockTabStrip that it is not a redock target anymore.

protected void RemovePreviousState(RedockState oldState)

Parameters:oldStateRedockState

RestoreState(DockWindow, DockState, bool)

Attempts to restore the state the window to the desired dock state.

public void RestoreState(DockWindow window, DockState state, bool defaultAction)

Parameters:windowDockWindowstateDockState

The target state which is to be restored.

defaultActionbool

True to perform default action if no state is recorded for a window, false otherwise.

RestoreState(IEnumerable<DockWindow>, DockState, bool)

Attempts to restore the state of each window to the specified one.

public void RestoreState(IEnumerable<DockWindow> windows, DockState state, bool defaultAction)

Parameters:windowsIEnumerable<DockWindow>stateDockState

The target state which is to be restored.

defaultActionbool

True to perform default action if no state is recorded for a window, false otherwise.

ResumeCleanUp(bool)

Resumes previously suspended clean-up.

public void ResumeCleanUp(bool forceCleanUp)

Parameters:forceCleanUpbool

True to force a clean-up pass, false otherwise.

SaveState(DockWindow)

Saves the current state of the specified window.

public virtual bool SaveState(DockWindow window)

Parameters:windowDockWindowReturns:

bool

SaveStateCore(DockWindow)

Preforms the core Save logic.

protected virtual bool SaveStateCore(DockWindow window)

Parameters:windowDockWindowReturns:

bool

SuspendCleanUp()

Temporary suspends any clean-up operations. Used by the owning RadDock instance to prevent undesired processing during multiple transactions stack.

public void SuspendCleanUp()