WbkRibbon

Description

The WbkRibbon component is used to implement workbook ribbon.

Comments

The component is implemented by the WbkRibbon class.

A workbook is the main functional area of a database. It is used to work with time series.

The ribbon contains commands, grouped and positioned in tabs. Each tab is related to operation type, for example working with data or page layout. Some of the tabs are shown only when necessary.

When window of time series database is resized, ribbon buttons are scaled.

Main purpose and functions of the ribbon:

• Collapsing and expanding the ribbon.

• Setting up Quick Access toolbar.

Example

This component looks as follows:

The example of component use is given on the Example of Creating the WbkRibbon Component page.

Constructor

	Constructor name	Brief description
	WbkRibbon	The WbkRibbon constructor creates an instance of the WbkRibbon class

Events

	Event name	Brief description
	MetadataChanged	The MetadataChanged event occurs on changing component metadata.

Properties inherited from the WbkRibbonView class

	Property name	Brief description
	ChartDataView	The ChartDataView property determines the chart, which settings will be edited from the ribbon.
	Source	The Source property determines a data source for the ribbon.

Methods inherited from the WbkRibbonView class

	Method name	Brief description
	getChartCategory	The getChartCategory method returns the Chart tab on the workbook ribbon.
	getDataCategory	The getDataCategory method returns the Data tab on the workbook ribbon.
	getFormulasCategory	The getFormulasCategory method returns the Calculations tab on the workbook ribbon.
	getMainCategory	The getMainCategory method returns the Home tab on the workbook ribbon.
	getReadonlyCategory	The getReadonlyCategory method returns the Home ribbon tab in the view mode.
	getTableCategory	The getTableCategory method returns the Table tab on the workbook ribbon.
	getTitleCategory	The getTitleCategory method returns the Title tab on the workbook ribbon.
	getTitleView	The getTitleView method returns workbook title.
	getViewCategory	The getViewCategory method returns the View tab on the workbook ribbon.
	refresh	The refresh method refreshes the specified control on the time series ribbon.
	refreshAll	The refreshAll method refreshes the ribbon contents.
	showPrintPreview	The showPrintPreview method displays workbook preview window.
	setPropertyValue	The setPropertyValue method sets value of ribbon properties.

Events inherited from the WbkRibbonView class

	Event name	Brief description
	Closed	The Closed event occurs on selecting the Close item in workbook main menu.
	Collapsed	The Collapsed event occurs on collapsing the ribbon.
	CreatedReport	The CreatedReport event occurs on selecting the New Workbook item in workbook main menu.
	Discuss	The Discuss event occurs on selecting the Discuss in SharePoint or Share items in the workbook main menu.
	DisplayTreeChanged	The DisplayTreeChanged event occurs after changing series tree appearance in the workbook ribbon.
	Exited	The Exited event occurs on selecting the Exit item in workbook main menu.
	Expanded	The Expanded event occurs on expanding the ribbon.
	Exported	The Exported event occurs on selecting the Export item in the workbook main menu.
	Opened	The Opened event occurs on selecting the Open item in the main menu.
	Printing	The Printing event occurs on selecting the Print menu item in the workbook main menu.
	PropertyChanged	The PropertyChanged event occurs after changing a ribbon property.
	RequestMetadata	The RequestMetadata event occurs when no metadata is available in the ribbon source.
	SaveAs	The SaveAs event occurs on selecting the Save As item in the main menu.
	Saved	The Saved event occurs on selecting the Save item in the main menu.

Methods inherited from the class ProxyControl

	Method name	Brief description
	getControl	The getControl method returns the basic control that inherits from PP.Ui.Control.

Properties inherited from the class Control

	Property name	Brief description
	Anchors	The Anchors property determines position of the component placed within container.
	Animation	The Animation property sets animation parameters for component.
	Bottom	The Bottom property sets bottom offset on placing the component within the LayoutPanel.
	Content	The Content property sets the component contents.
	ContextMenu	The ContextMenu property sets the context menu for the component.
	Data	The Data property is used to store any custom data.
	DataContext	The DataContext property contains an object with data.
	Enabled	The Enabled property sets whether the component is enabled.
	Height	The Height property determines the component height.
	IsResizable	The IsResizable property determines whether the component can be resized.
	IsRTL	The lsRTL property sets right to left text direction.
	IsVisible	The IsVisible property determines whether the component is displayed.
	Left	The Left property sets left offset on placing the component within the GridPanel.
	Offset	The Offset property determines coordinates of root DOM node of a control.
	Opacity	The Opacity property determines component transparency.
	Parent	The Parent property determines a parent component of a control.
	ParentNode	The ParentNode property sets parent DOM node.
	ResourceKey	The ResourceKey property sets the resource key for the component.
	Right	The Right property sets right offset on placing the component within the LayoutPanel.
	Rotate	The Rotate property sets component rotation angle.
	ShowToolTip	The ShowToolTip property determines whether the tooltip of the component can be displayed.
	Style	The Style property sets component style.
	TabIndex	The TabIndex property sets the order of the control element passing inside the container.
	Tag	The Tag property sets JSON object associated with the component.
	ToolTip	The ToolTip property determines text of component tooltip.
	Top	The Top property sets top offset on placing the component within the GridPanel.
	Value	The Value property sets the value to the component.
	Width	The Width property sets the component width.

Methods inherited from the class Control

	Method name	Brief description
	addClass	The addClass method adds a CSS class to the component.
	addEvent	The addEvent method adds an event handler to a DOM node.
	addEventHandler	The addEventHandler method adds an event handler to a DOM node.
	addEvents	The addEvents method adds an array of event handlers to a DOM node.
	addStateClass	The addStateClass method adds a CSS class to the component and removes the previous CSS class.
	addStyleBySelector	The addStyleBySelector method creates a block that contains a style with the specified CSS selector.
	addToNode	The addToNode method adds a component to the specified node.
	bindEvents	The bindEvents method subscribes an element to all available events.
	clearStylesCache	The clearStylesCache method clears cache of component styles.
	getAnchorFlags	The getAnchorFlags method returns JSON object that contains settings of the current component's position.
	getClass	The getClass method returns the current CSS classes of the component.
	getCssStyle	The getCssStyle method returns style for the specified node.
	getDomNode	The getDomNode method returns main DOM node of the component.
	getFocused	The getFocused method determines whether the component is focused.
	getFunctionByName	The getFunctionByName method returns function by name.
	getIsBinded	The getIsBinded method returns whether an element is subscribed to all DOM node events.
	hasClass	The hasClass method determines whether the specified CSS class is set for root DOM node of the control.
	hide	The hide method hides a control.
	hideToolTip	The hideToolTip method clears tooltip timeout and hides the tooltip if it is displayed.
	isResingNow	The isResingNow method determines whether the component is being resized.
	refreshBindingProperty	The refreshBindingProperty method refreshes the bound property by name.
	refreshItemsStyle	The refreshItemsStyle method refreshes CSS styles of child elements.
	refreshStyle	The refreshStyle method refreshes element CSS styles.
	removeClass	The removeClass method removes CSS class from the component.
	removeEvent	The removeEvent method removes event handler from DOM node.
	removeEventHandler	The removeEventHandler method removes event handler from DOM node.
	removeFromDOM	The removeFromDOM method removes node from the DOM structure.
	removeStateClasses	The removeStateClasses method removes CSS classes of the component.
	setDraggable	The setDraggable method determines whether it is possible to drag component on the HTML page.
	setFocus	The setFocus method sets the component focus.
	setIsHovered	The setIsHovered method displays the component as on hover.
	setIsPressed	The setIsPressed method displays the component as if clicked upon.
	setOpacityIE8	The setOpacityIE8 method sets component transparency value in Internet Explorer 8.
	setSize	The setSize method establishes the sizes of the component.
	show	The show method displays a control.
	unBindEvents	The unBindEvents method unsubscribes an element from all standard events.
	updatePosition	The updatePosition method updates size and position when absolute positioning based on the current parameters is used.
	updateSize	The updateSize method updates the component size on changing the size of the container that contains the component.

Events inherited from the class Control

	Event name	Brief description
	Drag	The Drag event occurs on clicking and holding the left mouse button.
	DragEnd	The DragEnd event occurs when dragging the component finishes.
	DragStart	The DragStart event occurs when dragging the component starts.
	OnContextMenu	The OnContextMenu event occurs on calling context menu of the component.
	SizeChanged	The SizeChanged event occurs after the component is resized.
	SizeChanging	The SizeChanging event occurs during component resize.

Properties inherited from the class Object

	Property name	Brief description
	Data	The Data property associates a random object with this component.
	Id	The Id property sets component identifier.
	Settings	The Settings property sets the component parameters.

Methods inherited from the class Object

	Method name	Brief description
	clone	The clone method creates a copy of object. It is not implemented in PP.Ui.Control.
	dispose	The dispose method deletes the component.
	getTypeName	The getTypeName method returns the name of the object type without the namespace, to which it belongs.

See also:

DHTML Components