WbkRibbonView.setPropertyValue

Syntax

setPropertyValue (propertyName, value);

Parameters

propertyName. Property name, an element of the PP.TS.Ui.WbkPropertyViews enumeration.

value. Property value.

Description

The setPropertyValue method sets values of tool ribbon properties.

Example

To execute the example, the page must contain the WorkbookBox component named workbookBox (see Example of Creating the WorkbookBox Component), and also add the following code in the handler, that processes document opening event:

//Get the Ribbon component
var ribbonView = workbookBox.getRibbonView();
var setPropertyValueButt = new PP.Ui.Button({
ParentNode: document.body, //DOM parent node
Content: "Set Property Values", //Text      
Click: PP.Delegate(onClickSetPropertyValue)     
}); 
var value = False;
function onClickSetPropertyValue()
{ 
	//Set value to VisibleBreadCrumb
	var propertyName = "VisibleBreadCrumb";
	ribbonView.setPropertyValue(propertyName, value);
	value = !value;
}

After executing the example the Set Properties Values button is placed on the page. Clicking this button toggles state of the Series Tree button in the Home ribbon tab.