ClassRedockService
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, INotifyPropertyChangingExInheritance: objectRadDockObjectRadDockServiceRedockService
Implements:
Inherited Members
Constructors
Properties
IsCleanUpSuspended
Determines whether clean-up is currently suspended.
StatesForCleanup
Gets an array with all the states that are currently marked for clean-up.
Declaration
protected RedockState[] StatesForCleanup { get; }Property Value
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.
Declaration
public void CleanUp()ClearAllStates(DockWindow)
Removes all the redock states saved for the specified window.
Declaration
public void ClearAllStates(DockWindow window)Parameters
window
ClearState(DockWindow, DockState)
Removes previously saved redock state for the specified window for the specified DockState.
Declaration
public bool ClearState(DockWindow window, DockState dockState)Parameters
window
dockState
Returns
GetNewDockState(DockState)
Retrieves the new DockState for a redock operation, depending on the provided current DockState.
GetState(DockWindow, DockState, bool)
Gets a RedockState instance for the specified window and DockState.
Declaration
protected RedockState GetState(DockWindow window, DockState state, bool remove)Parameters
window
The window for which to look-up a state.
state
The DockState to look-up for.
remove
True to remove the redock state from the list, false otherwise.
Returns
IsSaveApplicable(DockWindow)
Determines whether a Save operation is applicable for the specified window. Currently supported states are Docked and Floating.
Declaration
public bool IsSaveApplicable(DockWindow window)Parameters
window
Returns
Redock(DockWindow, RedockTransactionReason, bool)
Performs a redock operation upon specified window.
Declaration
public void Redock(DockWindow window, RedockTransactionReason reason, bool defaultAction)Parameters
window
reason
defaultAction
True to perform default action if no state is recorded for a window, false otherwise.
Redock(DockWindow, bool)
Declaration
public void Redock(DockWindow window, bool defaultAction)Parameters
window
defaultAction
Redock(IEnumerable<DockWindow>, RedockTransactionReason, bool)
Performs a redock operation upon specified windows.
Declaration
public void Redock(IEnumerable<DockWindow> windows, RedockTransactionReason reason, bool defaultAction)Parameters
windows
IEnumerable<DockWindow>
reason
defaultAction
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.
Declaration
public void Redock(IEnumerable<DockWindow> windows, bool defaultAction)Parameters
windows
IEnumerable<DockWindow>
defaultAction
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.
Declaration
protected void RemovePreviousState(RedockState oldState)Parameters
oldState
RestoreState(DockWindow, DockState, bool)
Attempts to restore the state the window to the desired dock state.
Declaration
public void RestoreState(DockWindow window, DockState state, bool defaultAction)Parameters
window
state
The target state which is to be restored.
defaultAction
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.
Declaration
public void RestoreState(IEnumerable<DockWindow> windows, DockState state, bool defaultAction)Parameters
windows
IEnumerable<DockWindow>
state
The target state which is to be restored.
defaultAction
True to perform default action if no state is recorded for a window, false otherwise.
ResumeCleanUp(bool)
Resumes previously suspended clean-up.
Declaration
public void ResumeCleanUp(bool forceCleanUp)Parameters
forceCleanUp
True to force a clean-up pass, false otherwise.
SaveState(DockWindow)
Saves the current state of the specified window.
Declaration
public virtual bool SaveState(DockWindow window)Parameters
window
Returns
SaveStateCore(DockWindow)
Preforms the core Save logic.
Declaration
protected virtual bool SaveStateCore(DockWindow window)Parameters
window
Returns
SuspendCleanUp()
Temporary suspends any clean-up operations. Used by the owning RadDock instance to prevent undesired processing during multiple transactions stack.
Declaration
public void SuspendCleanUp()