Documentation

Class RedockService

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

Inheritance
System.Object
RadDockObject
RadDockService
RedockService
Inherited Members
System.Object.ToString()
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.WinControls.UI.Docking
Assembly: Telerik.WinControls.RadDock.dll

Syntax

public class RedockService : RadDockService, IDisposable, INotifyPropertyChanged, INotifyPropertyChangingEx

Constructors

RedockService()

Default constructor.

Declaration
public RedockService()

Properties

IsCleanUpSuspended

Determines whether clean-up is currently suspended.

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

StatesForCleanup

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

Declaration
protected RedockState[] StatesForCleanup { get; }
Property Value
RedockState[]

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
DockWindow 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
DockWindow window

DockState dockState

Returns
System.Boolean

GetNewDockState(DockState)

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

Declaration
public static DockState GetNewDockState(DockState currState)
Parameters
DockState currState

Returns
DockState

GetState(DockWindow, DockState, Boolean)

Gets a RedockState instance for the specified window and DockState.

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

The window for which to look-up a state.
DockState state

The DockState to look-up for.
System.Boolean remove

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.

Declaration
public bool IsSaveApplicable(DockWindow window)
Parameters
DockWindow window

Returns
System.Boolean

Redock(IEnumerable<DockWindow>, Boolean)

Performs a redock operation upon specified windows.

Declaration
public void Redock(IEnumerable<DockWindow> windows, bool defaultAction)
Parameters
System.Collections.Generic.IEnumerable<DockWindow> windows

System.Boolean defaultAction

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

Redock(IEnumerable<DockWindow>, RedockTransactionReason, Boolean)

Performs a redock operation upon specified windows.

Declaration
public void Redock(IEnumerable<DockWindow> windows, RedockTransactionReason reason, bool defaultAction)
Parameters
System.Collections.Generic.IEnumerable<DockWindow> windows

RedockTransactionReason reason

System.Boolean defaultAction

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

Redock(DockWindow, Boolean)

Declaration
public void Redock(DockWindow window, bool defaultAction)
Parameters
DockWindow window

System.Boolean defaultAction

Redock(DockWindow, RedockTransactionReason, Boolean)

Performs a redock operation upon specified window.

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

RedockTransactionReason reason

System.Boolean 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
RedockState oldState

RestoreState(IEnumerable<DockWindow>, DockState, Boolean)

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

Declaration
public void RestoreState(IEnumerable<DockWindow> windows, DockState state, bool defaultAction)
Parameters
System.Collections.Generic.IEnumerable<DockWindow> windows

DockState state

The target state which is to be restored.
System.Boolean defaultAction

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

RestoreState(DockWindow, DockState, Boolean)

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

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

DockState state

The target state which is to be restored.
System.Boolean defaultAction

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

ResumeCleanUp(Boolean)

Resumes previously suspended clean-up.

Declaration
public void ResumeCleanUp(bool forceCleanUp)
Parameters
System.Boolean 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
DockWindow window

Returns
System.Boolean

SaveStateCore(DockWindow)

Preforms the core Save logic.

Declaration
protected virtual bool SaveStateCore(DockWindow window)
Parameters
DockWindow window

Returns
System.Boolean

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

Extension Methods