SPRibbonCommandHandler.SetGenericBlockingMessage method

Causes a modal error dialog box to display with the string that is passed in as an argument, with an OK button to dismiss that dialog box.

Namespace:  Microsoft.SharePoint.WebControls
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public Sub SetGenericBlockingMessage ( _
    s As String _
)
'Usage
Dim instance As SPRibbonCommandHandler
Dim s As String

instance.SetGenericBlockingMessage(s)
public void SetGenericBlockingMessage(
    string s
)

Parameters

  • s
    Type: System.String

    A string used in the modal error dialog box.

Remarks

The SetGenericBlockingMessage(String) alerts the customer to errors that happened on the server side that have caused the intended action to fail. For example, User A is viewing a particular page but does not have it checked out and User B then views and checks out that same page. If User A clicks the checkout button, then the check-out must fail.

See also

Reference

SPRibbonCommandHandler class

SPRibbonCommandHandler members

Microsoft.SharePoint.WebControls namespace