Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ScrollViewScope

class in UnityEditor

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

Description

Disposable helper class for managing BeginScrollView / EndScrollView.

These work just like GUILayout.ScrollViewScope but feel more application-like and should be used in the editor


Label inside a scroll view.

#pragma strict
// Simple Editor Window that creates a scroll view with a Label inside
class BeginEndScrollView extends EditorWindow {
	var scrollPos: Vector2;
	var t: String = "This is a string inside a Scroll view!";
	@MenuItem("Examples/Write text on ScrollView")
	static function Init() {
		var window: var = GetWindow.<BeginEndScrollView>();
		window.Show();
	}
	function OnGUI() {
		var h: var = new EditorGUILayout.HorizontalScope();
		 {
			var scrollView: var = 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 = "";
	}
}
using UnityEngine;
using UnityEditor;

// Simple Editor Window that creates a scroll view with a Label inside class 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 = ""; } }

Properties

handleScrollWheelWhether this ScrollView should handle scroll wheel events. (default: true).
scrollPositionThe modified scrollPosition. Feed this back into the variable you pass in, as shown in the example.

Constructors

EditorGUILayout.ScrollViewScopeCreate a new ScrollViewScope and begin the corresponding ScrollView.

Did you find this page useful? Please give it a rating: