SPRibbonScriptManager.RegisterGetCommandsFunction Method
Registers an ECMAScript function that returns an array of command identifiers.
Namespace: Microsoft.SharePoint.WebControls
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No
Syntax
'Declaration
Public Sub RegisterGetCommandsFunction ( _
control As Control, _
functionName As String, _
commands As IEnumerable(Of IRibbonCommand) _
)
'Usage
Dim instance As SPRibbonScriptManager
Dim control As Control
Dim functionName As String
Dim commands As IEnumerable(Of IRibbonCommand)
instance.RegisterGetCommandsFunction(control, _
functionName, commands)
public void RegisterGetCommandsFunction(
Control control,
string functionName,
IEnumerable<IRibbonCommand> commands
)
Parameters
control
Type: System.Web.UI.ControlThe control that is registering the function.
functionName
Type: System.StringThe name of the function.
commands
Type: System.Collections.Generic.IEnumerable<IRibbonCommand>The commands to include in the function.
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | control is a null reference (Nothing in Visual Basic). functionName is a null reference (Nothing in Visual Basic). |