Class LayouterBase

Base layouter for NavigationView control.

Inheritance

System.Object

LayouterBase

Implements

ILayouter

System.IDisposable

IAreasStateCache

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Windows.Forms.Tools.Navigation.Layouting

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public class LayouterBase : ILayouter, IDisposable, IAreasStateCache

Constructors

LayouterBase()

Initializes a new instance of the LayouterBase class.

Declaration

public LayouterBase()

Fields

AdjustButtonWidth

Declaration

public const int AdjustButtonWidth = 4

Field Value

Type
System.Int32

BarDropDownButtonWidth

Declaration

public const int BarDropDownButtonWidth = 16

Field Value

Type
System.Int32

BarHorzPadding

Declaration

public const int BarHorzPadding = 5

Field Value

Type
System.Int32

DropDownButtonWidth

Declaration

public const int DropDownButtonWidth = 16

Field Value

Type
System.Int32

HistoryBackButtonWidth

Declaration

public const int HistoryBackButtonWidth = 28

Field Value

Type
System.Int32

HistoryButtonHeight

Declaration

public const int HistoryButtonHeight = 28

Field Value

Type
System.Int32

HistoryDropDownButtonWidth

Declaration

public const int HistoryDropDownButtonWidth = 15

Field Value

Type
System.Int32

HistoryForwardButtonWidth

Declaration

public const int HistoryForwardButtonWidth = 26

Field Value

Type
System.Int32

TextBoxHorizontalPadding

Declaration

public const int TextBoxHorizontalPadding = 4

Field Value

Type
System.Int32

TextBoxVerticalPadding

Declaration

public const int TextBoxVerticalPadding = 4

Field Value

Type
System.Int32

UpButtonButtonWidth

Declaration

public const int UpButtonButtonWidth = 24

Field Value

Type
System.Int32

Properties

BarLayoutInfos

Gets the layout information for Bars.

Declaration

public BarLayoutInfoCollection BarLayoutInfos { get; }

Property Value

Type
BarLayoutInfoCollection

BorderBounds

Gets the border's bounds.

Declaration

public virtual Rectangle BorderBounds { get; }

Property Value

Type
System.Drawing.Rectangle

RootLayoutBar

Gets Bar of current layout.

Declaration

public virtual Bar RootLayoutBar { get; }

Property Value

Type
Bar

TextFormat

Gets the string format used in layouting.

Declaration

public TextFormatFlags TextFormat { get; }

Property Value

Type
System.Windows.Forms.TextFormatFlags

Methods

ClearAreaStates()

Clears all cached area states.

Declaration

public List<LayoutInfo> ClearAreaStates()

Returns

Type	Description
System.Collections.Generic.List<LayoutInfo>	Collection of cleared layouts.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Dispose(Boolean)

Releases unmanaged and - optionally - managed resources

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	true to release both managed and unmanaged resources; false to release only unmanaged resources.

Finalize()

Finalizes an instance of the LayouterBase class. LayouterBase is reclaimed by garbage collection.

Declaration

protected void Finalize()

GetAreaState(LayoutInfo)

Gets the state of the hit test area.

Declaration

public AreaStates GetAreaState(LayoutInfo info)

Parameters

Type	Name	Description
LayoutInfo	info	Area's layout information.

Returns

Type	Description
AreaStates	Area's state

GetLayout(HitTestAreas)

Gets the Layouting information for the specifies area of NavigationView control.

Declaration

public LayoutInfo GetLayout(HitTestAreas area)

Parameters

Type	Name	Description
HitTestAreas	area	The area.

Returns

Type	Description
LayoutInfo	Layouting information of the area.

GetSpaceAreaHeight(NavigationView)

Gets the height of the space area.

Declaration

protected virtual int GetSpaceAreaHeight(NavigationView navView)

Parameters

Type	Name	Description
NavigationView	navView	The navigation view.

Returns

Type	Description
System.Int32	Returns integer value

GetTextBoxHeight(NavigationView)

Gets the height of the text box.

Declaration

protected virtual int GetTextBoxHeight(NavigationView navView)

Parameters

Type	Name	Description
NavigationView	navView	The navigation view.

Returns

Type	Description
System.Int32	Returns TextBox Height

HitTest(Point)

Performs hits test.

Declaration

public virtual LayoutInfo HitTest(Point point)

Parameters

Type	Name	Description
System.Drawing.Point	point	Tested hit point.

Returns

Type	Description
LayoutInfo	Layouting info of hit test area.

MeasureText(NavigationView, Graphics, String)

Measures the text used in NavigationView.

Declaration

public virtual Size MeasureText(NavigationView navView, Graphics g, string text)

Parameters

Type	Name	Description
NavigationView	navView	The NavigationView control.
System.Drawing.Graphics	g	Graphics to measure at.
System.String	text	The text to be measured.

Returns

Type	Description
System.Drawing.Size	Size of measured text.

SetAreaState(LayoutInfo, AreaStates)

Sets the state of the hit test area.

Declaration

public void SetAreaState(LayoutInfo info, AreaStates areaState)

Parameters

Type	Name	Description
LayoutInfo	info	Area's layout information.
AreaStates	areaState	Area's state.

SetBounds(HitTestAreas, Rectangle)

Gets the bounds for the specifies area of NavigationView control.

Declaration

protected void SetBounds(HitTestAreas area, Rectangle bounds)

Parameters

Type	Name	Description
HitTestAreas	area	The area.
System.Drawing.Rectangle	bounds	The area's bounds.

UpdateLayout(NavigationView)

Updates the layout of NavigationView control according to its state.

Declaration

public virtual void UpdateLayout(NavigationView navView)

Parameters

Type	Name	Description
NavigationView	navView	The NavigationView control.

Implements

ILayouter

System.IDisposable

IAreasStateCache