Class DocumentWindow
Corresponds to a window hosted in the tabbed document window area
Inherited Members
Namespace: ABB.Robotics.RobotStudio.Environment
Assembly: ABB.Robotics.RobotStudio.Environment.dll
Syntax
public class DocumentWindow : Window, IDisposable
Constructors
DocumentWindow()
Creates a new Window
Declaration
public DocumentWindow()
Remarks
The Window's ID will be set to null.
DocumentWindow(Object)
Creates a new Window
Declaration
public DocumentWindow(object id)
Parameters
Type | Name | Description |
---|---|---|
Object | id | The ID of the window (can be null) |
DocumentWindow(Object, Control)
Creates a new Window containing the specified Control
Declaration
public DocumentWindow(object id, Control control)
Parameters
Type | Name | Description |
---|---|---|
Object | id | The ID of the window (can be null) |
Control | control | The contained Control |
DocumentWindow(Object, Control, String)
Creates a new Window
Declaration
public DocumentWindow(object id, Control control, string caption)
Parameters
Type | Name | Description |
---|---|---|
Object | id | The ID of the window (can be null) |
Control | control | The contained Control |
String | caption | The initial caption of the window |
Properties
ActiveDocumentWindow
Gets or sets the active document window
Declaration
public static DocumentWindow ActiveDocumentWindow { get; set; }
Property Value
Type | Description |
---|---|
DocumentWindow |
Category
Sets the category that the window belongs to. Windows from the same category will be grouped together.
Declaration
public string Category { get; set; }
Property Value
Type | Description |
---|---|
String |
FullScreen
Display the window in fullscren mode on a second display, if one is available
Declaration
olete("Use WindowMode instead")]
public bool FullScreen { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Locked
Gets or sets whether the user is allowed to close the window (and/or make it floating), or if it is locked in place.
Declaration
public bool Locked { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Maximized
Returns if window is in maximized state. Only relevant for floating windows.
Declaration
public bool Maximized { get; }
Property Value
Type | Description |
---|---|
Boolean |
StatusBarPanes
Returns a collection of StatusBar panes only visible when this window is the active document window
Declaration
public StatusBarPaneCollection StatusBarPanes { get; }
Property Value
Type | Description |
---|---|
StatusBarPaneCollection |
WindowMode
Specifies where the window is displayed.
Declaration
public DocumentWindowMode WindowMode { get; set; }
Property Value
Type | Description |
---|---|
DocumentWindowMode |
Methods
Maximize()
Maximize the window. Only relevant for floating windows.
Declaration
public void Maximize()
Restore()
Restore the window from maximized to normal. Only relevant for floating windows.
Declaration
public void Restore()
Events
ActiveDocumentWindowChanged
Raised when the active document window is changed
Declaration
public static event EventHandler ActiveDocumentWindowChanged
Event Type
Type | Description |
---|---|
EventHandler |