Struct Navigation
Assembly: UnityEngine.UI.dll
Syntax
[Serializable]
public struct Navigation : IEquatable<Navigation>
Properties
defaultNavigation
Return a Navigation with sensible default values.
Declaration
public static Navigation defaultNavigation { get; }
Property Value
Examples
using UnityEngine;
using System.Collections;
using UnityEngine.UI;
public class ExampleClass : MonoBehaviour
{
public Button button;
void Start()
{
button.navigation = Navigation.defaultNavigation;
}
}
mode
Declaration
public Navigation.Mode mode { get; set; }
Property Value
selectOnDown
Specify a Selectable UI GameObject to highlight when the down arrow key is pressed.
Declaration
public Selectable selectOnDown { get; set; }
Property Value
Examples
using UnityEngine;
using System.Collections;
using UnityEngine.UI;
public class HighlightOnKey : MonoBehaviour
{
public Button btnSave;
public Button btnLoad;
public void Start()
{
Navigation navigation = btnLoad.navigation;
navigation.mode = Navigation.Mode.Explicit;
navigation.selectOnDown = btnSave;
btnLoad.navigation = navigation;
}
}
selectOnLeft
Specify a Selectable UI GameObject to highlight when the left arrow key is pressed.
Declaration
public Selectable selectOnLeft { get; set; }
Property Value
Examples
using UnityEngine;
using System.Collections;
using UnityEngine.UI;
public class HighlightOnKey : MonoBehaviour
{
public Button btnSave;
public Button btnLoad;
public void Start()
{
Navigation navigation = btnLoad.navigation;
navigation.mode = Navigation.Mode.Explicit;
navigation.selectOnLeft = btnSave;
btnLoad.navigation = navigation;
}
}
selectOnRight
Specify a Selectable UI GameObject to highlight when the right arrow key is pressed.
Declaration
public Selectable selectOnRight { get; set; }
Property Value
Examples
using UnityEngine;
using System.Collections;
using UnityEngine.UI;
public class HighlightOnKey : MonoBehaviour
{
public Button btnSave;
public Button btnLoad;
public void Start()
{
Navigation navigation = btnLoad.navigation;
navigation.mode = Navigation.Mode.Explicit;
navigation.selectOnRight = btnSave;
btnLoad.navigation = navigation;
}
}
selectOnUp
Specify a Selectable UI GameObject to highlight when the Up arrow key is pressed.
Declaration
public Selectable selectOnUp { get; set; }
Property Value
Examples
using UnityEngine;
using System.Collections;
using UnityEngine.UI;
public class HighlightOnKey : MonoBehaviour
{
public Button btnSave;
public Button btnLoad;
public void Start()
{
Navigation navigation = btnLoad.navigation;
navigation.mode = Navigation.Mode.Explicit;
navigation.selectOnUp = btnSave;
btnLoad.navigation = navigation;
}
}
wrapAround
Enables navigation to wrap around from last to first or first to last element.
Will find the furthest element from the current element in the opposite direction of movement.
Declaration
public bool wrapAround { get; set; }
Property Value
Examples
Note: If you have a grid of elements and you are on the last element in a row it will not wrap over to the next row it will pick the furthest element in the opposite direction.
Methods
Equals(Navigation)
Declaration
public bool Equals(Navigation other)
Parameters
Returns
Implements
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.