The WbkPropertyBar component is used to view and manage workbook properties using navigation panel.
The component is implemented by the WbkPropertyBar class.
This component looks as follows:
The example of creating the component is given on the WbkPropertyBar Constructor page.
Constructor name | Brief description | |
WbkPropertyBar | The WbkPropertyBar constructor creates an instance of the WbkPropertyBar class |
Property name | Brief description | |
GridView | The GridView property determines a component that displays a table. | |
Source | The Source property returns the workbook, which data is displayed in the component. | |
Type | The Type property determines a property panel type. |
Method name | Brief description | |
deleteExtraRevisionPanels | The deleteExtraRevisionPanels method removes from the property panel the tabs that correspond to sources (time series databases) not contained in the workbook. | |
getChartMaster | The getChartMaster method returns chart wizard. | |
getEquationAutoFitPanel | The getEquationAutoFitPanel method returns the exponential smoothing parameters autofit panel. | |
getEquationPeriodPanel | The getEquationPeriodPanel method returns the Calculation Periods panel. | |
getEquationProcessPanel | The getEquationProcessPanel method returns the Missing Data Treatment panel. | |
getEquationSmoothingSlidingPanel | The getEquationSmoothingSlidingPanel method returns the Moving Average panel. | |
getEquationWeightCoefficientsPanel | The getEquationWeightCoefficientsPanel method returns the Weight Coefficients panel. | |
getGaugeMaster | The getGaugeMaster method returns speedometer setup wizard. | |
getMainSeriesPanel | The getMainSeriesPanel method returns the Primary panel. | |
getMapMaster | The getMapMaster method returns map wizard. | |
getNavBreadcrumb | The getNavBreadcrumb method returns the component that is used to control workbook attributes. | |
getObserveAttributesPanel | The getObserveAttributesPanel method returns the Observation Attributes panel. | |
getParametersPanel | The getParametersPanel method returns the parameters panel. | |
getPeriodSeriesViewPanel | The getPeriodSeriesViewPanel method returns the panel that is used to control workbook attributes. | |
getSerieAttributesPanel | The getSerieAttributesPanel method returns the Series Attributes panel of the Series tab. | |
getSerieRevisionsPanel | The getSerieRevisionsPanel method returns the Revisions panel of the Series tab. | |
getSeriesAttributesPanel | The getSeriesAttributesPanel method returns the Data panel of the Format tab. | |
getSerieValidationErrorsPanel | The getSerieValidationErrorsPanel method returns the Validation Errors panel of the Series tab. | |
getTablePanel | The getTablePanel method returns the Data panel of the Data tab. | |
getTableViewPanel | The getTableViewPanel method returns the View panel of the Format tab. | |
getTitlePanel | The getTitlePanel method returns the Title panel of the Format tab. | |
getValidationErrorsPanel | The getValidationErrorsPanel method returns the Validation Errors panel of the Observation tab. | |
getValidationPanel | The getValidationPanel method returns the Validation Rules panel. | |
hideAllMasters | The hideAllMasters method hides all wizards that belong to groups. | |
loadFile | The loadFile method loads a file with the specified name. | |
refreshAll | The refreshAll method refreshes the entire component. | |
showChartMaster | The showChartMaster method displays chart setup wizard. | |
showGaugeMaster | The showGaugeMaster method displays speedometer setup wizard. | |
showGroup | The showGroup method displays a group of properties panel by identifier. | |
showMapMaster | The showMapMaster method displays map setup wizard. | |
showOnlyGroup | The showOnlyGroup method displays a group of properties panel by identifier and hides all the others. | |
updateRevisionPanel | The updateRevisionPanel method recreates revisions panel. | |
updateViewAsMenu | The updateViewAsMenu method refreshes the Apply Transformation drop-down list on the Primary panel. |
Event name | Brief description | |
PropertyChanged | The PropertyChanged event occurs when the user finishes changing workbook properties. | |
PropertyChanging | The PropertyChanging event occurs when workbook properties start changing. | |
RequestMetadata | The RequestMetadata event occurs on metadata request. |
Method name | Brief description | |
getControl | The getControl method returns the basic control that inherits from PP.Ui.Control. |
Property name | Brief description | |
Anchors | The Anchors property determines position of the component placed within container. | |
Animation | The Animation property determines component animation parameters. | |
Bottom | The Bottom property determines a bottom margin if a component is placed inside LayoutPanel. | |
Content | The Content property determines component contents. | |
ContextMenu | The ContextMenu property determines a component's context menu. | |
Data | The Data property is used to store any custom data. | |
Enabled | The Enabled property determines whether a component can be used. | |
Height | The Height property determines component height. | |
IsRTL | The IsRTL property determines whether component elements are aligned to the right. | |
IsVisible | The IsVisible property determines whether a component is displayed. | |
Left | The Left property determines a left margin if a component is placed inside GridPanel. | |
Opacity | The Opacity property determines component transparency. | |
Parent | The Parent property determines a parent component of a control. | |
ParentNode | The ParentNode property determines a parent DOM node. | |
ResourceKey | The ResourceKey property determines a component resource key. | |
Right | The Right property determines a right margin if a component is placed inside LayoutPanel. | |
Rotate | The Rotate property determines a component rotation angle. | |
ShowToolTip | The ShowToolTip property determines whether a tooltip of the component can be displayed. | |
Style | The Style property determines a component style. | |
TabIndex | The TabIndex property determines the order of the control element passing inside the container. | |
Tag | The Tag property determines a JSON object associated with the component. | |
ToolTip | The ToolTip property determines text of component tooltip. | |
Top | The Top property determines a top margin if a component is placed inside GridPanel. | |
Value | The Value property determines a component value. | |
Width | The Width property determines component width. |
Method name | Brief description | |
The addClass method adds a CSS class to the component. | ||
addEventHandler | The addEventHandler method adds an event handler to a DOM node. | |
The addStateClass method adds a CSS class to the component and removes the previous CSS class. | ||
The addToNode method adds a component to the specified node. | ||
bindEvents | The bindEvents method subscribes an element to all available events. | |
The getAnchorFlags method returns JSON object that contains settings of the current component's position. | ||
The getClass method returns the current CSS classes of the component. | ||
The getCssStyle method returns style for the specified node. | ||
The getDomNode method returns main DOM node of the component. | ||
The getFocused method determines whether the component is focused. | ||
getIsBinded | The getIsBinded method returns whether an element is subscribed to all DOM node events. | |
The hide method hides a control. | ||
The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown. | ||
refreshStyle | The refreshStyle method refreshes element CSS styles. | |
The removeClass method removes CSS class from the component. | ||
removeEventHandler | The removeEventHandler method removes event handler from DOM node. | |
removeFromDOM | The removeFromDOM method removes node from the DOM structure. | |
The removeStateClasses method removes CSS classes of the component. | ||
The setDraggable method determines whether a component can be dragged on the HTML page. | ||
The setFocus method sets the component focus. | ||
The setIsHovered method sets up component displaying only on mouseover. | ||
The setSize method establishes the sizes of the component. | ||
The show method displays a control. | ||
unBindEvents | The unBindEvents method unsubscribes an element from all standard events. | |
The updatePosition method updates size and position when absolute positioning based on the current parameters is used. | ||
The updateSize method updates the component size on changing the size of the container that contains the component. |
Event name | Brief description | |
Drag | The Drag event occurs on clicking and holding the 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. |
Property name | Brief description | |
The Id property determines a repository object identifier. |
Method name | Brief description | |
clone | The clone method creates an object copy. | |
dispose | The dispose method deletes the component. | |
getHashCode | The getHashCode method returns hash code of repository object. | |
getId | The getId method returns repository object identifier. | |
getSettings | The getSettings method returns repository object settings. | |
getTypeName | The getTypeName method returns the name of the object type without the namespace, to which it belongs. | |
isEqual | The isEqual method determines whether the specified object is equal to the current repository object. | |
isLive | The isLive method determines validity of repository object. | |
removeAllEvents | The removeAllEvents method removes all object event handlers by the specified context. | |
setId | The setId method determines a repository object identifier. | |
setSettings | The setSettings method determines repository object settings. | |
defineProps | The defineProps method creates get and set methods from name array for the specified class. | |
keys | The keys method returns array of methods and properties names for the specified object. |
See also: