Struct Navigation

Implements

IEquatable<Navigation>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.UI

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

Type	Description
Navigation

Examples

using UnityEngine;
using System.Collections;
using UnityEngine.UI; // Required when Using UI elements.

public class ExampleClass : MonoBehaviour
{
    public Button button;

    void Start()
    {
        //Set the navigation to the default value. ("Automatic" is the default value).
        button.navigation = Navigation.defaultNavigation;
    }
}

mode

Navigation mode.

Declaration

public Navigation.Mode mode { get; set; }

Property Value

Type	Description
Navigation.Mode

selectOnDown

Specify a Selectable UI GameObject to highlight when the down arrow key is pressed.

Declaration

public Selectable selectOnDown { get; set; }

Property Value

Type	Description
Selectable

Examples

using UnityEngine;
using System.Collections;
using UnityEngine.UI;  // Required when Using UI elements.

public class HighlightOnKey : MonoBehaviour
{
    public Button btnSave;
    public Button btnLoad;

    public void Start()
    {
        // get the Navigation data
        Navigation navigation = btnLoad.navigation;

        // switch mode to Explicit to allow for custom assigned behavior
        navigation.mode = Navigation.Mode.Explicit;

        // highlight the Save button if the down arrow key is pressed
        navigation.selectOnDown = btnSave;

        // reassign the struct data to the button
        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

Type	Description
Selectable

Examples

using UnityEngine;
using System.Collections;
using UnityEngine.UI;  // Required when Using UI elements.

public class HighlightOnKey : MonoBehaviour
{
    public Button btnSave;
    public Button btnLoad;

    public void Start()
    {
        // get the Navigation data
        Navigation navigation = btnLoad.navigation;

        // switch mode to Explicit to allow for custom assigned behavior
        navigation.mode = Navigation.Mode.Explicit;

        // highlight the Save button if the left arrow key is pressed
        navigation.selectOnLeft = btnSave;

        // reassign the struct data to the button
        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

Type	Description
Selectable

Examples

using UnityEngine;
using System.Collections;
using UnityEngine.UI;  // Required when Using UI elements.

public class HighlightOnKey : MonoBehaviour
{
    public Button btnSave;
    public Button btnLoad;

    public void Start()
    {
        // get the Navigation data
        Navigation navigation = btnLoad.navigation;

        // switch mode to Explicit to allow for custom assigned behavior
        navigation.mode = Navigation.Mode.Explicit;

        // highlight the Save button if the right arrow key is pressed
        navigation.selectOnRight = btnSave;

        // reassign the struct data to the button
        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

Type	Description
Selectable

Examples

using UnityEngine;
using System.Collections;
using UnityEngine.UI;  // Required when Using UI elements.

public class HighlightOnKey : MonoBehaviour
{
    public Button btnSave;
    public Button btnLoad;

    public void Start()
    {
        // get the Navigation data
        Navigation navigation = btnLoad.navigation;

        // switch mode to Explicit to allow for custom assigned behavior
        navigation.mode = Navigation.Mode.Explicit;

        // highlight the Save button if the up arrow key is pressed
        navigation.selectOnUp = btnSave;

        // reassign the struct data to the button
        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

Type	Description
bool

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

Type	Name	Description
Navigation	other

Returns

Type	Description
bool

Implements

IEquatable<T>