EditorGUILayout.ScrollViewScope
Disposable helper class for managing EditorGUILayout.BeginScrollView / EditorGUILayout.EndScrollView.
Read time 2 minutesLast updated 5 days ago
Definition
- Type: Class
- Namespace: UnityEditor
- Assembly: UnityEditor.CoreModule
- Inherits from: Scope
- Implements: IDisposable
public class EditorGUILayout.ScrollViewScope : GUI.Scope, IDisposable
Remarks
These work just like GUILayout.ScrollViewScope but feel more application-like and should be used in the editor
Label inside a scroll view.
Examples
using UnityEngine;using UnityEditor;// Simple Editor Window that creates a scroll view with a Label insideclass BeginEndScrollView : EditorWindow{ Vector2 scrollPos; string t = "This is a string inside a Scroll view!"; [MenuItem("Examples/Write text on ScrollView")] static void Init() { var window = GetWindow<BeginEndScrollView>(); window.Show(); } void OnGUI() { using (var h = new EditorGUILayout.HorizontalScope()) { using (var scrollView = new EditorGUILayout.ScrollViewScope(scrollPos, GUILayout.Width(100), GUILayout.Height(100))) { scrollPos = scrollView.scrollPosition; GUILayout.Label(t); } if (GUILayout.Button("Add More Text", GUILayout.Width(100), GUILayout.Height(100))) t += " \nAnd this is more text!"; } if (GUILayout.Button("Clear")) t = ""; }}
Constructors
Constructor | Description |
|---|---|
| ScrollViewScope(UnityEngine.Vector2,System.Boolean,System.Boolean,UnityEngine.GUILayoutOption[]) | Create a new ScrollViewScope and begin the corresponding ScrollView. |
| ScrollViewScope(UnityEngine.Vector2,System.Boolean,System.Boolean,UnityEngine.GUIStyle,UnityEngine.GUIStyle,UnityEngine.GUIStyle,UnityEngine.GUILayoutOption[]) | Create a new ScrollViewScope and begin the corresponding ScrollView. |
| ScrollViewScope(UnityEngine.Vector2,UnityEngine.GUILayoutOption[]) | Create a new ScrollViewScope and begin the corresponding ScrollView. |
| ScrollViewScope(UnityEngine.Vector2,UnityEngine.GUIStyle,UnityEngine.GUILayoutOption[]) | Create a new ScrollViewScope and begin the corresponding ScrollView. |
| ScrollViewScope(UnityEngine.Vector2,UnityEngine.GUIStyle,UnityEngine.GUIStyle,UnityEngine.GUILayoutOption[]) | Create a new ScrollViewScope and begin the corresponding ScrollView. |
Properties
Property | Description |
|---|---|
| handleScrollWheel | Whether this ScrollView should handle scroll wheel events. (default: true). |
| scrollPosition | The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. |