How to programmatically refresh a Sitecore item on Content Editor upon editing it

Question

I would like to refresh a Sitecore item after editing it programmatically.

Scenario: An Action of a workflow opens a dialog, does some operation and on clicking the OK button I want to refresh the Item on the Content Editor.

I tried the following approaches but they didn't work.

string load = string.Concat("item:load(id=", workflowItem.ID, ",language=", workflowItem.Language, ",version=", workflowItem.Version, ")");
Context.ClientPage.SendMessage(this, load);

string refresh = $"item:refreshchildren(id={workflowItem.ID})";
Context.ClientPage.ClientResponse.Timer(refresh, 12);

Your help is highly appreceiated.

Code Used for Custom Action:

public class ShowAuthenticationDialog
{
    public void Process(WorkflowPipelineArgs args)
    {
        CreateContext(args);
    }

    private void CreateContext(WorkflowPipelineArgs args)
    {
        string controlUri = UIUtil.GetUri("control:AuthenticationDialog");
        Item item = args.DataItem;
        string nextStateId =  args.CommandItem.Fields["Authentication Next State"]?.GetValue(true);

        UrlString controlUrlString = new UrlString($"{controlUri}&ItemId={item.ID}&WorkflowNextStateId={nextStateId}");

        SheerResponse.ShowModalDialog(controlUrlString.ToString());

        string load = $"item:load(id={item.ID},language={item.Language},version={item.Version})";
        Context.ClientPage.SendMessage(this, load);
    }
}

Code for the OnOk method

    protected override void OnOK(object sender, EventArgs args)
    {
        Assert.ArgumentNotNull(sender, "sender");
        Assert.ArgumentNotNull(args, "args");

        string itemId = WebUtil.GetQueryString("ItemId");
        Database database = Factory.GetDatabase("master");
        Item workflowItem = database.GetItem(itemId);

        //TODO: Pass credentials to authentication service
        if (true)
        {
            string newStateId = WebUtil.GetQueryString("WorkflowNextStateId");
            string newState = database.GetItem(newStateId)?.DisplayName;

            if (!string.IsNullOrWhiteSpace(newState))
            {
                ChangeWorkflowState(workflowItem, newState);

                string load = $"item:load(id={workflowItem.ID},language={workflowItem.Language},version={workflowItem.Version})";
                Context.ClientPage.SendMessage(this, load);

                string refresh = $"item:refreshchildren(id={workflowItem.ID})";
                Context.ClientPage.ClientResponse.Timer(refresh, 12);

                //TODO: Add History
            }
        }

        base.OnOK(sender, args);
    }

Answer 1

After hours of investigating the issue, I found the problem that I am supposed to send the load command using ClientResponse instead of SendMessage.

Thanks, everyone for your help.

 string load = $"item:load(id={workflowItem.ID},language={workflowItem.Language},version={workflowItem.Version})";
 Context.ClientPage.ClientResponse.Timer(load, 2);

Answer 2

Try to add a Context.ClientPage.ClientResponse.Alert("test this should work");in your OnOk Methode.

If this is not working you call it the wrong way. Put a Context.ClientPage.Start((object)this, "Run", args.Parameters);in your OnOK methode.

And somethings like this:

protected new void Run(ClientPipelineArgs args) {
    Log.Info("Run method is called");

    some code to check and get the workflowItem

    Context.ClientPage.ClientResponse.Alert("Hello, just for testing");

    string load = $"item:load(id={workflowItem.ID},language={workflowItem.Language},version={workflowItem.Version})";
    Context.ClientPage.SendMessage(this, load);

    string refresh = $"item:refreshchildren(id={workflowItem.ID})";
    Context.ClientPage.ClientResponse.Timer(refresh, 2);
}