AGI Ui Core 11 Send comments on this topic.
IAgUiWindow Interface

Description

Represents a window abstraction. Provides methods and properties to manipulate the position and the state of the window.

Object Model


Public Methods

Public Method Activate Activates the window.
Public Method Close Closes the window.
Public Method GetServiceByName Returns a service object that can be accessed at runtime. The method returns null if no service object is associated with the specified symbolic name.
Public Method GetServiceByType Returns a service object that can be accessed at runtime. The method returns null if no service object is associated with the specified service type.

Public Properties

Public Property Caption The window caption. Can only be set within UI plugins for the non unique windows they own.
Public Property DockStyle The window docking style.
Public Property Height The window height.
Public Property Left The window horizontal position.
Public Property NoWBClose Whether to close the window when the application workbook is loaded/closed.
Public Property SupportsPinning Returns whether the window supports pinning.
Public Property Toolbars Returns the window's toolbar collection.
Public Property Top The window vertical position
Public Property UnPinned The window's pinned state. A window is considered to be unpinned if its pin icon is sideways, or it does not have a pin icon (e.g., when the window is floating, integrated, or dockable but not docked).
Public Property Width The window width.
Public Property WindowState The window state.
© 2016 Analytical Graphics, Inc. All Rights Reserved.

STK Programming Interface 11.0.1