AGI UI PluginsSend comments on this topic.
ShowDialog Method (IAgUiPluginHtmlWindowSite)
See Also
Plugin
A User Interface plugin object.
Url
A URL of the document to display.
DialogParams
Optional parameters that can be used to specify an initial size and position of the window.
Windows





Windows & Linux

Description

Opens a modal HTML window and loads the document specified by a given URL.

Syntax

[Visual Basic .NET]
Public Function ShowDialog( _
    ByVal Plugin As IAgUiPlugin, _
    ByVal Url As String, _
    ByVal DialogParams As System.Array _
) As Integer
[C#]
public int ShowDialog(
    IAgUiPlugin Plugin,
    string Url,
    System.Array DialogParams
);
[Managed C++]
public: int ShowDialog(
    IAgUiPlugin ^ Plugin,
    String __gc ^ Url,
    System::Array ^ DialogParams
);
[Unmanaged C++]
public: HRESULT ShowDialog(
    IAgUiPlugin * Plugin,
    BSTR Url,
    SAFEARRAY * * DialogParams,
    long * pResult
);
[Java]
public int showDialog(
    IAgUiPlugin Plugin,
    String Url,
    AgSafeArray DialogParams
);

Parameters

Plugin
A User Interface plugin object.
Url
A URL of the document to display.
DialogParams
Optional parameters that can be used to specify an initial size and position of the window.

Remarks

ShowDialog method opens an HTML browser in a modal dialog and displays the contents of the document using the specified URL.

See Also

Example

Open an HTML document in a modal dialog
// IAgUiPluginSite Site;

IAgUiPluginHtmlWindowSite windowSite = Site as IAgUiPluginHtmlWindowSite;
Array @params = Array.CreateInstance(typeof(object), 0);
int ret = windowSite.ShowDialog(this, "http://www.agi.com", ref @params);
Open an HTML document in a modal dialog using specified position and size
// IAgUiPluginSite Site;

IAgUiPluginHtmlWindowSite windowSite = Site as IAgUiPluginHtmlWindowSite;
Array @params = Array.CreateInstance(typeof(object), 5);

//@params[0] = caption text
//@params[1] = left
//@params[2] = top
//@params[3] = width
//@params[4] = height    

@params.SetValue("A custom HTML dialog", 0);
@params.SetValue(100, 1);
@params.SetValue(100, 2);
@params.SetValue(600, 3);
@params.SetValue(600, 4);
int ret = windowSite.ShowDialog(this, "http://www.agi.com", ref @params);
© 2026 Analytical Graphics, Inc. All Rights Reserved.