I now have a solution that works that I got from a colleague.
While it doesn't solve the more general case of launching this dialog from any VSTO C# code, it does work for launching this dialog correctly as a result of clicking a toolbar button (which is what we are trying to do). So this fixes the problem for us.
I'm actually of the opinion now that this is a bug (feature?) of MS Word and that there isn't any general way of displaying this dialog from code and having the "Options..." button enabled. I think it can only work if the dialog is invoked automatically by MS Word due to it being hooked up to the CommandBar as a built-in control. I've seen the same behaviour in VBA as well as through VSTO which tends to support the theory that it's a Word limitation/bug.
So we previously had code like this:
public MyCommandBar()
{
_myBar = App.CommandBars.Add("My Toolbar", 1, Type.Missing, true);
// Add a button to call our custom event handler
_printSetup = (CommandBarButton)
_myBar.Controls.Add(MsoControlType.msoControlButton,
Type.Missing, Type.Missing, 1, true);
_printSetup.Click += printSetup_Click(); // Call the handler shown in my original question
// More stuff...
}
And when modified to call the built-in control by changing the second argument (Id) to Controls.Add() from Type.Missing to 511 (the ID for the File Print Setup dialog) like this the "Options..." button is enabled like one would expect:
public MyCommandBar()
{
_myBar = App.CommandBars.Add("My Toolbar", 1, Type.Missing, true);
// Call the built-in File Print Setup dialog automagically
_printSetup = (CommandBarButton)
_myBar.Controls.Add(MsoControlType.msoControlButton,
511, Type.Missing, 1, true);
// More stuff...
}
Hopefully this helps others who run into this problem.