Version: 2022.3
LanguageEnglish
  • C#

EditorWindow.GetWindow

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public static EditorWindow GetWindow(Type windowType, bool utility = false, string title = null, bool focus = true);

Parameters

windowType The type of the window. Must derive from EditorWindow.
utility Set this to true, to create a floating utility window, false to create a normal window.
title If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title.
focus Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus).

Returns

EditorWindow An EditorWindow instance of windowType.

Description

Returns the first EditorWindow of type windowType which is currently on the screen.

If there is none, creates and shows new window and returns the instance of it.


Simple Empty non-dockable window.

using UnityEngine;
using UnityEditor;

// Simple script that creates a new non-dockable window.
public class EditorWindowTest : EditorWindow
{
    [MenuItem("Examples/Display simple Window")]
    static void Initialize()
    {
        var window = (EditorWindowTest)EditorWindow.GetWindow(typeof(EditorWindowTest), true, "My Empty Window");
    }
}

Declaration

public static T GetWindow();

Declaration

public static T GetWindow(bool utility);

Declaration

public static T GetWindow(bool utility, string title);

Declaration

public static T GetWindow(string title);

Declaration

public static T GetWindow(string title, bool focus);

Declaration

public static T GetWindow(bool utility, string title, bool focus);

Parameters

T The type of the window. Must derive from EditorWindow.
utility Set this to true, to create a floating utility window, false to create a normal window.
title If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title.
focus Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus).

Returns

T An EditorWindow instance of type T.

Description

Returns the first EditorWindow of type T which is currently on the screen.

If there is none, creates and shows new window and returns the instance of it.


Declaration

public static T GetWindow(params Type[] desiredDockNextTo);

Declaration

public static T GetWindow(string title, params Type[] desiredDockNextTo);

Declaration

public static T GetWindow(string title, bool focus, params Type[] desiredDockNextTo);

Parameters

T The type of the window. Must derive from EditorWindow.
title If GetWindow creates a new window, it will get this title. If this value is null, use the class name as title.
desiredDockNextTo An array of EditorWindow types that the window will attempt to dock onto.
focus Whether to give the window focus, if it already exists. (If GetWindow creates a new window, it will always get focus).

Returns

T An EditorWindow instance of type T.

Description

Returns the first EditorWindow of type T which is currently on the screen.

If there is none, creates and shows new window and returns the instance of it. The created window will attempt to be docked next to the first founds specified window type.