.. default-domain:: cs
.. highlight:: csharp
.. namespace:: KRPC.Client.Services.UI

Dropdown
========


.. class:: Dropdown

   A control for choosing one of a list of options, which are shown when it is clicked.
   Added to a :type:`Canvas` or a :type:`Panel`.

   .. property:: RectTransform RectTransform { get; }

      The rect transform for the UI object.

      :Game Scenes: All

   .. property:: LayoutElement LayoutElement { get; }

      How much space the UI object asks a layout for.

      :Game Scenes: All


      .. note::

         Only has an effect when the object is in a panel that has a layout. A canvas is
         not inside a layout and does not have one.

   .. property:: bool Visible { get; set; }

      Whether the UI object is visible.

      :Game Scenes: All


      .. note::

         This is the object's own setting, which is what it was last set to. An object is
         only drawn when everything it is inside is visible as well, so an interface can
         be built with its parts visible, inside a panel that is not, and shown all at
         once by making that panel visible.

   .. property:: System.Collections.Generic.IList<string> Options { get; set; }

      The options that the dropdown offers.

      :Game Scenes: All


      .. note::

         Setting the options resets the selection to the first of them, or to nothing
         when the list is empty.

   .. property:: int SelectedIndex { get; set; }

      The position in :prop:`Dropdown.Options` of the option that is chosen.

      :Game Scenes: All


      .. note::

         Zero while the dropdown has no options, as there is nothing to choose.

   .. property:: bool Changed { get; set; }

      Whether the chosen option has been changed.

      :Game Scenes: All


      .. note::

         This property is set to true when the user chooses an option, and not when a
         client chooses one.
         A client script should reset the property to false in order to detect subsequent changes.

   .. property:: bool Interactable { get; set; }

      Whether the control responds to the user.

      :Game Scenes: All


      .. note::

         A control that is not interactable is drawn grayed out and ignores the user,
         but is still visible. Set its visibility to false to hide it instead.

   .. property:: StdLib.ColorRGBA Color { get; set; }

      The color the control is tinted with. White, the default, leaves the control drawn
      as the skin has it.

      :Game Scenes: All


      .. note::

         The tint multiplies the sprite the control is drawn with, in every state, so
         a control can show a state of its own, an engaged autopilot for instance, by
         color. It is applied to the part of the control that responds to the user:
         the body of a button, dropdown or input field, the box of a toggle, and the
         handle of a slider. A control's label is tinted through the color of its
         text.

   .. property:: string Tooltip { get; set; }

      A short piece of text shown beside the pointer while it rests on the
      control. Empty, the default, shows nothing.

      :Game Scenes: All

   .. function:: void Remove()

      Remove the UI object.


      :Game Scenes: All