C# Class ComponentFactory.Krypton.Toolkit.ViewLayoutDocker

Extends the ViewComposite by applying a docking style for each child.
Inheritance: ViewComposite
Mostra file Open project: ComponentFactory/Krypton Class Usage Examples

Public Methods

Method Description
Add ( ViewBase item, ViewDockStyle dock ) : void

Append a view to the collection.

GetDock ( ViewBase child ) : ViewDockStyle

Gets the dock setting for the provided child instance.

GetPreferredSize ( ViewLayoutContext context ) : Size

Discover the preferred size of the element.

Layout ( ViewLayoutContext context ) : void

Perform a layout of the elements.

SetDock ( ViewBase child, ViewDockStyle dock ) : void

Sets the dock setting for the provided child instance.

ToString ( ) : string

Obtains the String representation of this instance.

ViewLayoutDocker ( ) : System

Initialize a new instance of the ViewLayoutDocker class.

Protected Methods

Method Description
CalculateDock ( ViewDockStyle ds, Control control ) : ViewDockStyle

Find the actual docking to apply for the specified RightToLeft setting.

OrientateDock ( ViewDockStyle style ) : ViewDockStyle

Update the incoming dock style to reflect our orientation.

UpdateFillerRect ( Rectangle fillerRect, Control control ) : Rectangle

Allow the filler rectangle calculated by Layout to be modified before use.

UpdatePreferredSize ( Size preferredSize ) : Size

Allow the preferred size calculated by GetPreferredSize to be modified before use.

Private Methods

Method Description
UpdateChildBorders ( ViewBase child, ViewLayoutContext context, PaletteDrawBorders &leftEdges, PaletteDrawBorders &rightEdges, PaletteDrawBorders &topEdges, PaletteDrawBorders &bottomEdges, PaletteDrawBorders &fillEdges ) : void

Method Details

Add() public method

Append a view to the collection.
public Add ( ViewBase item, ViewDockStyle dock ) : void
item ViewBase ViewBase reference.
dock ViewDockStyle DockStyle setting.
return void

CalculateDock() protected method

Find the actual docking to apply for the specified RightToLeft setting.
protected CalculateDock ( ViewDockStyle ds, Control control ) : ViewDockStyle
ds ViewDockStyle Docking style.
control System.Windows.Forms.Control Control for which the setting is needed.
return ViewDockStyle

GetDock() public method

Gets the dock setting for the provided child instance.
public GetDock ( ViewBase child ) : ViewDockStyle
child ViewBase Child view element.
return ViewDockStyle

GetPreferredSize() public method

Discover the preferred size of the element.
public GetPreferredSize ( ViewLayoutContext context ) : Size
context ViewLayoutContext Layout context.
return System.Drawing.Size

Layout() public method

Perform a layout of the elements.
public Layout ( ViewLayoutContext context ) : void
context ViewLayoutContext Layout context.
return void

OrientateDock() protected method

Update the incoming dock style to reflect our orientation.
protected OrientateDock ( ViewDockStyle style ) : ViewDockStyle
style ViewDockStyle Incoming dock style.
return ViewDockStyle

SetDock() public method

Sets the dock setting for the provided child instance.
public SetDock ( ViewBase child, ViewDockStyle dock ) : void
child ViewBase Child view element.
dock ViewDockStyle ViewDockStyle setting.
return void

ToString() public method

Obtains the String representation of this instance.
public ToString ( ) : string
return string

UpdateFillerRect() protected method

Allow the filler rectangle calculated by Layout to be modified before use.
protected UpdateFillerRect ( Rectangle fillerRect, Control control ) : Rectangle
fillerRect System.Drawing.Rectangle Original filler rectangle.
control System.Windows.Forms.Control Owning control instance.
return System.Drawing.Rectangle

UpdatePreferredSize() protected method

Allow the preferred size calculated by GetPreferredSize to be modified before use.
protected UpdatePreferredSize ( Size preferredSize ) : Size
preferredSize System.Drawing.Size Original preferred size value.
return System.Drawing.Size

ViewLayoutDocker() public method

Initialize a new instance of the ViewLayoutDocker class.
public ViewLayoutDocker ( ) : System
return System