STK UI PluginsSend comments on this topic.
CreateToolWindow Method (IAgUiPluginWindowSite)
See Also
Plugin
The plugin that creates the window.
EmbeddedControlUnk
A pointer to an instance of a native control that implements IAgUiPluginEmbeddedWindowHandle.
Caption
A text displayed as custom window title.
Windows





Windows & Linux

Description

Creates a custom tool window that hosts the control specified by the parameter pPlugin. The method returns a pointer to the newly created window.

Syntax

[Visual Basic .NET]
Public Function CreateToolWindow( _
    ByVal Plugin As IAgUiPlugin, _
    ByVal EmbeddedControlUnk As Object, _
    ByVal Caption As String _
) As IAgUiWindow
[C#]
public IAgUiWindow CreateToolWindow(
    IAgUiPlugin Plugin,
    Object EmbeddedControlUnk,
    string Caption
);
[Managed C++]
public: IAgUiWindow^ CreateToolWindow(
    IAgUiPlugin ^ Plugin,
    IUnknown ^ EmbeddedControlUnk,
    String __gc ^ Caption
);
[Unmanaged C++]
public: HRESULT CreateToolWindow(
    IAgUiPlugin * Plugin,
    IUnknown * EmbeddedControlUnk,
    BSTR Caption,
    IAgUiWindow ** ppWindow
);
[Java]
public IAgUiWindow createToolWindow(
    IAgUiPlugin Plugin,
    Object EmbeddedControlUnk,
    String Caption
);

Parameters

Plugin
The plugin that creates the window.
EmbeddedControlUnk
A pointer to an instance of a native control that implements IAgUiPluginEmbeddedWindowHandle.
Caption
A text displayed as custom window title.

Return Type

A new window.

Remarks

CreateToolWindow method allows creating custom windows that host the instances of native controls. Native controls are objects that support IAgUiPluginEmbeddedWindowHandle interface.

See Also

© 2025 Analytical Graphics, Inc. All Rights Reserved.