Version: 2019.2
LanguageEnglish
  • C#

GUI.HorizontalScrollbar

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

public static float HorizontalScrollbar(Rect position, float value, float size, float leftValue, float rightValue);
public static float HorizontalScrollbar(Rect position, float value, float size, float leftValue, float rightValue, GUIStyle style);

Parameters

positionRectangle on the screen to use for the scrollbar.
valueThe position between min and max.
sizeHow much can we see?
leftValueThe value at the left end of the scrollbar.
rightValueThe value at the right end of the scrollbar.
styleThe style to use for the scrollbar background. If left out, the horizontalScrollbar style from the current GUISkin is used.

Returns

float The modified value. This can be changed by the user by dragging the scrollbar, or clicking the arrows at the end.

Description

Make a horizontal scrollbar. Scrollbars are what you use to scroll through a document. Most likely, you want to use scrollViews instead.

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public float hSbarValue;

void OnGUI() { hSbarValue = GUI.HorizontalScrollbar(new Rect(25, 25, 100, 30), hSbarValue, 1.0F, 0.0F, 10.0F); } }

Finding extra elements:

The styles of the buttons at the end of the scrollbar are searched for in the current skin by adding "leftbutton" and "rightbutton" to the style name. The name of the scrollbar thumb (the thing you drag) is found by appending "thumb" to the style name.

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public float scrollPos = 0.5f;

// This will use the following style names to determine the size / placement of the buttons // MyScrollbarleftbutton - Name of style used for the left button. // MyScrollbarrightbutton - Name of style used for the right button. // MyScrollbarthumb - Name of style used for the draggable thumb. void OnGUI() { scrollPos = GUI.HorizontalScrollbar(new Rect(0, 0, 100, 20), scrollPos, 1.0f, 0.0f, 100.0f, "Scroll"); } }

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