SP.Ribbon.PageManager.executeRootCommand(commandId, properties, commandInfo, root) Method

Applies to: SharePoint Foundation 2010

In this article
Return Value
Remarks
Applies To

Executes a command against the registered handlers for the command dispatcher.

var value = SP.Ribbon.PageManager.executeRootCommand(commandId, properties, commandInfo, root);

Parameters

commandId

Type: string

The ID of the command.

properties

Type: Object

The properties of the command.

commandInfo

Type: Object

The information about the command.

root

Type: Object

The root in which the command was executed.

Return Value

Type: Boolean

true if the command was executed successfully; otherwise, false.

Remarks

This method calls the base class CUI.Page.PageManager.executeRootCommand(commandId, properties, commandInfo, root) Method method with the same parameter list to execute the command. If the command is a user command, this method logs the time that the command takes to execute to the Software Quality Metrics (SQM) data file.

Use the CUI.Page.CommandDispatcher.registerCommandHandler(commandId, handler) Method method to add a handler for a command.

Applies To

SP.Ribbon.PageManager Class

See Also

Reference

SP.Ribbon.PageManager Methods

SP.Ribbon.PageManager Properties

SP.Ribbon Namespace