Class RibbonStateParams

Represent the state of Whole Ribbon Control

Inheritance

System.Object

RibbonStateParams

Namespace: Syncfusion.Windows.Tools

Assembly: Syncfusion.Tools.Wpf.dll

Syntax

public class RibbonStateParams : Object

Constructors

RibbonStateParams()

Initializes a new instance of the RibbonStateParams class.

Declaration

public RibbonStateParams()

RibbonStateParams(QuickAccessToolBar, ArrayList, String, String, Boolean, RibbonState, ArrayList)

Initializes a new instance of the RibbonStateParams class.

Declaration

public RibbonStateParams(QuickAccessToolBar bar, ArrayList qatApplicationitemindex, string qatString, string qatItemsInitialString, bool isQATBelow, RibbonState ribbonState, ArrayList windowCoordinates)

Parameters

Type	Name	Description
QuickAccessToolBar	bar	The bar.
System.Collections.ArrayList	qatApplicationitemindex
System.String	qatString
System.String	qatItemsInitialString
System.Boolean	isQATBelow
RibbonState	ribbonState	State of the ribbon.
System.Collections.ArrayList	windowCoordinates

Properties

BarOrderList

Gets or sets the collection of Bar Order.

Declaration

public ArrayList BarOrderList { get; set; }

Property Value

Type
System.Collections.ArrayList

CollapsedTabList

Gets or sets the Collapsed Tab collection.

Declaration

public ArrayList CollapsedTabList { get; set; }

Property Value

Type
System.Collections.ArrayList

EnableSimplifiedLayoutMode

Gets or sets the value that indicates whether the Ribbon will switch between its various LayoutMode values when clicking the ribbon minimize button. In Simplified mode, ribbon will arrange its items in single line allowing more screen space.

Declaration

public bool EnableSimplifiedLayoutMode { get; set; }

Property Value

Type	Description
System.Boolean	The System.Boolean value that is used to set the EnableSimplifiedLayoutMode. When set to true, you can switch between normal and simplified mode by clicking on the ribbon minimize button. When set to false, you can switch between normal and hidden state. Default value is False.

IsNew

Gets or sets check whether is new or not.

Declaration

public Nullable<bool> IsNew { get; set; }

Property Value

Type
System.Nullable<System.Boolean>

IsQATBelow

Gets or sets a value indicating whether this instance is QAT below.

Declaration

public bool IsQATBelow { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance is QAT below; otherwise, false.

LayoutMode

Gets or sets the LayoutMode that indicates whether the Ribbon 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 LayoutMode LayoutMode { get; set; }

Property Value

Type	Description
LayoutMode	The LayoutMode value that specifies whether the item is in Simplified or Normal mode. Default value is Normal.

QatApplicationItemIndex

Gets or sets the collection of QAT Application item index.

Declaration

public ArrayList QatApplicationItemIndex { get; set; }

Property Value

Type	Description
System.Collections.ArrayList	The QAT items string.

QATItemsIndex

Gets or Sets the Index of Items in QAT menu.

Declaration

public ArrayList QATItemsIndex { get; set; }

Property Value

Type
System.Collections.ArrayList

QATItemsInitialString

Gets or sets the QAT items initial string.

Declaration

public string QATItemsInitialString { get; set; }

Property Value

Type	Description
System.String	The QAT items initial string.

QATItemsString

Gets or sets the QAT items string.

Declaration

public string QATItemsString { get; set; }

Property Value

Type	Description
System.String	The QAT items string.

QATMenuItems

Gets or sets the QAT menu items.

Declaration

public ArrayList QATMenuItems { get; set; }

Property Value

Type	Description
System.Collections.ArrayList	The QAT menu items.

RibbonCustomTabCollection

Gets or sets the Ribbon custom Tab collection.

Declaration

public ArrayList RibbonCustomTabCollection { get; set; }

Property Value

Type
System.Collections.ArrayList

RibbonDynamicBarCollection

Gets or sets the Ribbon Dynamic Bar collection.

Declaration

public ArrayList RibbonDynamicBarCollection { get; set; }

Property Value

Type
System.Collections.ArrayList

RibbonDynamicItemCollection

Gets or sets the Ribbon Dynamic Item collection.

Declaration

public ArrayList RibbonDynamicItemCollection { get; set; }

Property Value

Type
System.Collections.ArrayList

RibbonDynamicTabCollection

Gets or sets the Ribbon Dynamic Tab collection.

Declaration

public ArrayList RibbonDynamicTabCollection { get; set; }

Property Value

Type
System.Collections.ArrayList

RibbonOldTabCollection

Gets or sets the Ribbon Old Tab collection.

Declaration

public ArrayList RibbonOldTabCollection { get; set; }

Property Value

Type
System.Collections.ArrayList

RibbonState

Gets or sets the state of the ribbon.

Declaration

public RibbonState RibbonState { get; set; }

Property Value

Type	Description
RibbonState	The state of the ribbon.

TabOrderList

Get or sets the Tab Order

Declaration

public ArrayList TabOrderList { get; set; }

Property Value

Type
System.Collections.ArrayList

WindowStates

Gets or sets the window states.

Declaration

public ArrayList WindowStates { get; set; }

Property Value

Type	Description
System.Collections.ArrayList	The window states.