DockableWindow Object
Description
A DockableWindow object represents a window that can be docked on to the Inventor application window by the user.
Methods
| AddChild |
Method that adds a dialog or a control to the dockable window. Currently, you can only add a single child to a dockable window. So this method returns a failure if the dockable window already has a child. It is the responsibility of the client to destroy the dialog/control as and when appropriate. |
| Clear |
Method that empties the contents of the dockable window (i.e. removes any children of the window). This does not destroy the child dialog/controls; it is the responsibility of the client to destroy them. |
| Delete |
Method that deletes the DockableWindow. This does not destroy the child dialog/controls; it is the responsibility of the client to destroy them. |
| GetDockingState |
Method that gets the docking state of the dockable window. |
| Move |
Method that repositions and resizes the window. If the window is docked, calling this method automatically undocks the window and honors the input values. |
| SetDockingState |
Method that set the docking state of the window. |
| SetMinimumSize |
Method that sets the minimum size that the user can resize the window to. |
Properties
| Application |
Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned. |
| Caption |
Gets and sets the caption of the window. |
| ClientId |
Property that returns the string that uniquely identifies the client. This is the CLSID of the AddIn in a string form, e.g. '{C9A6C580-3817-11D0-BE4E-080036E87B02}'. |
| Control |
Property that returns the control associated with the pane. This property returns Nothing if the pane contains a dialog and not a control. |
| DisableCloseButton |
Gets and sets whether to disable close button. |
| DisabledDockingStates |
Read-write property that gets and sets the bit-mask that specifies the docking positions to disallow. |
| Height |
Gets and sets the current height of the window. |
| HWND |
Property that returns the handle of the dockable window. |
| InternalName |
Property that returns the unique internal name of the window. |
| IsCustomized |
Property that returns whether size, position and docking states of this window have previously been customized and remembered by Inventor. If this property returns True, the size, position and docking states should not be initialized by the creating application so that the last known values are re-applied. |
| Left |
Property that returns the distance between the left edge of the screen and left edge of the window. |
| Parent |
Property that returns the parent UserInterfaceManager object. |
| ShowVisibilityCheckBox |
Gets and sets whether to display the visibility check box in the User Interface dropdown in the View tab | Windows panel. |
| Top |
Property that returns the distance between the top of the screen and top of the window. |
| Type |
Returns an ObjectTypeEnum indicating this object's type. |
| VisibilityControl |
Property that returns the button control automatically created by Inventor to control the visibility of the dockable window. |
| Visible |
Read-write property that gets and sets whether the window is currently visible. |
| Width |
Gets and sets the current width of the window. |
Accessed From
DockableWindows.Add,
DockableWindows.Item
Samples
| Dockable window |
This sample demonstrates creating a dockable window and adding a dialog into it. |
Version
Introduced in version 2011
