Class SimplifiedLayoutSettings

Represents the Simplified layout settings class for the Ribbon control.

Inheritance

System.Object

SimplifiedLayoutSettings

Namespace: Syncfusion.Windows.Tools.Controls

Assembly: Syncfusion.Tools.Wpf.dll

Syntax

public static class SimplifiedLayoutSettings : Object

Fields

ActiveDisplayModeProperty

Identifies the ActiveDisplayModeProperty dependency property.

Declaration

public static readonly DependencyProperty ActiveDisplayModeProperty

Field Value

Type
System.Windows.DependencyProperty

Remarks

The identifier for the ActiveDisplayModeProperty dependency property.

DisplayModeProperty

Identifies the DisplayModeProperty dependency property.

Declaration

public static readonly DependencyProperty DisplayModeProperty

Field Value

Type
System.Windows.DependencyProperty

Remarks

The identifier for the DisplayModeProperty dependency property.

LayoutModeProperty

Identifies the LayoutModeProperty dependency property.

Declaration

public static readonly DependencyProperty LayoutModeProperty

Field Value

Type
System.Windows.DependencyProperty

Remarks

The identifier for the LayoutModeProperty dependency property.

Methods

GetActiveDisplayMode(UIElement)

Gets the ActiveDisplayModeProperty value of the specified item which defines the ribbon item current visibility state during the various LayoutMode values.

Declaration

public static DisplayMode GetActiveDisplayMode(UIElement element)

Parameters

Type	Name	Description
System.Windows.UIElement	element	The element whose ActiveDisplayModeProperty must be retrieved.

Returns

Type	Description
DisplayMode	The DisplayMode value of the specified item

GetDisplayMode(UIElement)

Gets the DisplayModeProperty value of the specified item which denotes its visibility during the various LayoutMode values.

Declaration

public static DisplayMode GetDisplayMode(UIElement element)

Parameters

Type	Name	Description
System.Windows.UIElement	element	The element whose DisplayModeProperty must be retrieved.

Returns

Type	Description
DisplayMode	The DisplayMode value of the specified item

GetLayoutMode(UIElement)

Gets the LayoutModeProperty of the specified item that denotes whether it is in normal or in simplified mode.

Declaration

public static LayoutMode GetLayoutMode(UIElement element)

Parameters

Type	Name	Description
System.Windows.UIElement	element	The element whose LayoutModeProperty must be retrieved.

Returns

Type	Description
LayoutMode	The LayoutMode value of the specified item.

SetActiveDisplayMode(UIElement, DisplayMode)

Sets the ActiveDisplayModeProperty for the specified item which defines the ribbon item current visibility state during the various LayoutMode values.

Declaration

public static void SetActiveDisplayMode(UIElement element, DisplayMode value)

Parameters

Type	Name	Description
System.Windows.UIElement	element	The element to which the ActiveDisplayModeProperty must be set.
DisplayMode	value	The DisplayMode value.

SetDisplayMode(UIElement, DisplayMode)

Sets the DisplayModeProperty for the specified item which defines its visibility during the various LayoutMode values.

Declaration

public static void SetDisplayMode(UIElement element, DisplayMode value)

Parameters

Type	Name	Description
System.Windows.UIElement	element	The element to which the DisplayModeProperty must be set.
DisplayMode	value	The DisplayMode value

Examples

RibbonButton button = new RibbonButton();
// set display mode.
SimplifiedLayoutSettings.SetDisplayMode(button, DisplayMode.Normal | DisplayMode.OverflowMenu);

SetLayoutMode(UIElement, LayoutMode)

Sets the LayoutModeProperty that indicates whether the specified item is in normal or simplified mode.. When set to Simplified the Ribbon items will be arranged in a single line allowing more screen space.

Declaration

public static void SetLayoutMode(UIElement element, LayoutMode value)

Parameters

Type	Name	Description
System.Windows.UIElement	element	The element to which the LayoutModeProperty must be set.
LayoutMode	value	The LayoutMode value.