Click or drag to resize
KaxDockLayout Class
Workflow: 1). OnInit - ensure that the framework will call TrackViewState, LoadViewState and SaveViewState. We expect that all child docks will be created here. 2). TrackViewState - raise LoadDockLayout event in order to let the developer to supply the initial parents of the registered docks, because the docks could be created with different parents than needed. 2a). LoadViewState - loads and applies the dock parents from the ViewState in order to persist the dock positions between the page postbacks. 3). LoadPostData - returns true to ensure that RaisePostDataChangedEvent() 3a). Dock_DockZoneChanged - this event is raised by each dock in its LoadPostData method. We handle this event and store the pair UniqueName/NewDockZoneID in the _clientPositions Dictionary. This Dictionary will be used in #4. 4). RaisePostDataChangedEvent - sets the parents of the registered docks according their positions, set on the client. These positions are stored in the _clientPositions Dictionary. 5). OnLoad, other events, such as Click, Command, etc. If you create a dock here it will be rendered on the page, but if it is not recreated in the next OnInit, it will not persist its position, set on the client! 6). SaveViewState - stores the dock parents in the ViewState in order to persist their positions between the page postbacks. 7). Page_SaveStateComplete - raises the SaveDockLayout event to let the developer to save the state in a database or other storage medium. Note: The dock parents will be stored in the ViewState if StoreLayoutInViewState is set to true (default). Otherwise the developer should take care of the dock positions when the page is posted back.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    Kettic.AspNet.ControlsKaxDockLayout

Namespace: Kettic.AspNet.Controls
Assembly: Kettic.AspNet.Controls (in Kettic.AspNet.Controls.dll) Version: 2014.4.1129.0 (2014.04.1129.0)
Syntax
public class KaxDockLayout : Control, 
	IDockLayout, ISkinnableControl, IControl

The KaxDockLayout type exposes the following members.

Constructors
  NameDescription
Public methodKaxDockLayout
Top
Methods
  NameDescription
Public methodGetEmbeddedSkinNames
Return a collection of name for all embedded skin.
Public methodGetRegisteredDocksState
Cycles through all registered docks and retrieves their state. The List returned by this method could be used to recreate the docks when the user visits the page again.
Public methodGetRegisteredDocksState(Boolean)
Cycles through all registered docks and retrieves their state, depending on the omitClosedDocks parameter and the value of the Closed property of each KaxDock control. The List returned by this method could be used to recreate the docks when the user visits the page again.
Public methodSetRegisteredDockParents
Reorders the docks in the control tree, according the supplied parameters.
Top
Properties
  NameDescription
Public propertyEnableAjaxSkinRendering
Gets or sets a Boolean value that indicates whether render the skin CSS at AJAX request. The default value is true.
Public propertyEnableEmbeddedBaseStylesheet
Gets or sets a Boolean value that indicates whether enable the embedded basic style sheet in the control.
Public propertyEnableEmbeddedSkins
Gets or sets a Boolean value that indicates whether enable the embedded skin for the control.
Public propertyIsSkinSet
For internal use.
Public propertyRegisteredDocks
Returns all registered docks with this KaxDockLayout control.
Public propertyRegisteredZones
Returns all registered zones with this KaxDockLayout control.
Public propertySkin
Gets or sets the skin name for the child controls' user interface.
Public propertyStoreLayoutInViewState
By default KaxDockLayout will store the positions of its inner docks in the ViewState. If you want to store the positions in other storage medium such as a database, or the Session, set this property to false. Setting this property to false will also minimize the ViewState usage.
Top
Events
  NameDescription
Public eventLoadDockLayout
KaxDockLayout will raise the LoadDockLayout event in order to retrieve the parents which will be automatically applied on the registered docks. The client positions will be applied in a later stage of the lifecycle.
Public eventSaveDockLayout
KaxDockLayout will raise this event to let the developer to save the parents of the registered docks in a database or other storage medium. These parents can be later supplied to the LoadDockLayout event.
Top
See Also