FormatCategory

Namespace: PP.Exp.Ui;

Inheritance hierarchy

Object

Control

TabItem

RibbonCategory

EaxCategoryView

FormatCatView

FormatCategory

Description

The FormatCategory class implements the Format tab in the express report tool ribbon.

Syntax

PP.initClass(PP.Exp.Ui.FormatCategory, PP.Exp.Ui.FormatCatView, "FormatCategory");

Comments

The Format tool ribbon tab is available when the table is active.

Constructor

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

Methods inherited from the FormatCatView class

	Method name	Brief description
	getBordersAndFillColorControls	The getBordersAndFillColorControls method returns a panel with border and fill controls.
	getContentRendered	The getContentRendered method returns whether the Format tab contents is rendered.
	getCurrentFormatControls	The getCurrentFormatControls method returns a drop-down list for selecting table element and the Format button.
	getFontBox	The getFontBox method returns text settings control.
	getSelectPartCombo	The getSelectPartCombo method returns a drop-down list for selecting table element.
	getSlaveCategoriesPanels	The getSlaveCategoriesPanels method returns child panels of the Constructor tab.
	refresh	The refresh method refreshes data of the Format tab on the express report ribbon.
	refreshTextNBordersNFillColor	The refreshTextNBordersNFillColor method sets actual values for border and fill controls.
	renderContent	The renderContent method renders tab contents.

Properties inherited from the EaxCategoryView class

	Property name	Brief description
	DataView	The DataView property determines a data view in the express report working area.
	Source	The Source property determines a data source for a tab of express report ribbon.

Methods inherited from the EaxCategoryView class

	Method name	Brief description
	getChartDataSourceState	The getChartDataSourceState method determines the data range presented in visualizers.
	getChartEditingMenu	The getChartEditingMenu method returns menu of editing of express report toolbar chart.
	getChartTypeMenu	The getChartTypeMenu method returns the Type menu that is used to select chart display type.
	getColTotalsButton	The getColTotalsButton method returns the Column Totals button on the express report ribbon.
	getCondFormatButton	The getCondFormatButton method returns the Conditional Formatting button on the express report ribbon.
	getDataTypeMenu	The getDataTypeMenu method returns the Transform Data menu on the express report ribbon.
	getDataTypeState	The getDataTypeState method returns properties of the Transform Data menu shown on the ribbon.
	getDimViewModeButton	The getDimViewModeButton method returns the Side Panel button on the express report ribbon.
	getFilterButton	The getFilterButton method returns the Filter button on the express report ribbon.
	getFilterMenu	The getFilterMenu method returns the Filter menu on the express report ribbon.
	getFilterState	The getFilterState method returns properties of the Filter menu on the ribbon.
	getGrowthIndicatorMenu	The getGrowthIndicatorMenu method returns the Growth Indicator menu on the express report ribbon.
	getIndButton	The getIndButton method returns the Growth Indicator button on the express report ribbon.
	getOptions	The getOptions method returns an object with settings of the ribbon tab.
	getRankingButton	The getRankingButton method returns the Show As Ranks button on the express report ribbon.
	getRankingMenu	The getRankingMenu method returns the Show As Ranks menu on the express report ribbon.
	getRankingState	The getRankingState method returns properties of the Show As Ranks menu on the ribbon.
	getRowsTotalsButton	The getRowsTotalsButton method returns the Row Totals button on the express report ribbon.
	getTableAreaChartMenu	The getTableAreaChartMenu method returns the Select Data menu on the Chart tab of the express report ribbon.
	getTableCFormatButtonMenu	The getTableCFormatButtonMenu method returns the Conditional Formatting menu on the express report ribbon.
	getTableCFormatState	The getTableCFormatState method returns properties of the Conditional Formatting menu shown on the ribbon.
	getTitleButton	The getTitleButton method returns the Title button on the express report ribbon.
	getTitleMenu	The getTitleMenu method returns the Select Data menu of the Home tab of the express report ribbon.
	getTotalsInColumnsMenu	The getTotalsInColumnsMenu method returns the Column Totals menu of the express report ribbon.
	getTotalsInRowsMenu	The getTotalsInRowsMenu method returns the Row Totals menu on the express report ribbon.
	getTotalsState	The getTotalsState method returns properties of the Row Totals and Column Totals menus on the ribbon.
	getTypeDataButton	The getTypeDataButton method returns the Transform Data button on the express report ribbon.
	loadFile	The loadFile method loads JavaScript scenario file.
	refreshAll	The refreshAll method refreshes all contents of ribbon tab.

Events inherited from the EaxCategoryView class

	Event name	Brief description
	ControlsCreated	The ControlsCreated event occurs after creating controls of tab of express report ribbon.
	MetadataChanged	The MetadataChanged event occurs after changing metadata of an express report ribbon tab.
	PropertyChanged	The PropertyChanged event occurs after changing property of a tab on the express report ribbon.
	Refreshed	The Refreshed event occurs after refreshing tab of express report ribbon.
	RequestMetadata	The RequestMetadata event occurs if no metadata is contained in the source of the express report ribbon tab.

Properties inherited from the class RibbonCategory

	Property name	Brief description
	Caption	The Caption property sets tab header.
	GroupName	The GroupName property sets a name for a group of context tabs.

Methods inherited from the class RibbonCategory

	Method name	Brief description
	addPanel	The addPanel method adds a panel to the tab.
	getGroupName	The getGroupName method returns the name of tabs' group.
	getPanels	The getPanels method returns the array of tab panels.

Properties inherited from the class TabItem

	Property name	Brief description
	Caption	The Caption property sets tab header.
	ImageUrl	The ImageUrl property sets the path to the tab image.
	Position	The Position property sets tab position.

Methods inherited from the class TabItem

	Method name	Brief description
	getContentNodes	The getContentNodes method returns the collection of DOM nodes from tab contents.
	getOrderNumber	The getOrderNumber method returns sequence number of the tab.
	getParent	The getParent method returns the TabControlcomponent that is a parent one relative to the tab.

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:

PP.Exp.Ui