DockableWindows.Add Method

Parent Object: DockableWindows

Description

Method that creates a new DockableWindow. The newly created DockableWindow is returned. The window is created invisible and is undocked. The window remains invisible until explicitly made visible by the creator of the window.

Remarks

A visibility toggle control for the window is automatically added by Inventor to the 'User Interface' dropdown in the View tab | Windows panel. The VisibilityControl property returns this control.

Syntax

DockableWindows.Add( ClientId As String, InternalName As String, Title As String ) As DockableWindow

Parameters

Name Type Description
ClientId String Input String that uniquely identifies the client. This is the CLSID of the AddIn in a string form, e.g. "{C9A6C580-3817-11D0-BE4E-080036E87B02}". If supplied, this string is used at Inventor start up time to determine whether the AddIn that created this ribbon tab has since been uninstalled. If so, settings (such as window position, docking state, etc.) associated with the window are deleted. The string is also used to find all the windows to delete when the associated Add-in is unloaded. A 'dummy' string or a null string can be specified, but is not recommended.
InternalName String Input String that specifies a unique internal name for the window. This name is never displayed to the user and is only used (in combination with ClientId) to uniquely identify the window.
Title String Input String that specifies the title of the window. This should be a localized string.

Samples

Name Description
Dockable window This sample demonstrates creating a dockable window and adding a dialog into it.

Version

Introduced in version 2011