logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class UnityUiSubmitComponent

    Unity-specific UI submit component that handles button interactions and submission events with optional selector adaptation.
    Provides button functionality with text display, layout management, and dynamic selector width adjustment based on text content.
    Implements IUiSubmittable interface for submission event handling within the Unity UI system.

    Inheritance
    object
    UnityUiComponent
    UnityUiInteractableComponent
    UnityUiSubmitComponent
    UnityUiSelectorComponent
    Implements
    IUiInteractable
    IUiComponent
    IUiSubmittable
    IComponent
    IFoundationSettings
    Inherited Members
    UnityUiInteractableComponent._contentWrapperGameObject
    UnityUiInteractableComponent._labelGameObject
    UnityUiInteractableComponent._highlightGameObject
    UnityUiInteractableComponent._valueGameObject
    UnityUiInteractableComponent._mainButtonGameObject
    UnityUiInteractableComponent._optionValueUiComponentType
    UnityUiInteractableComponent._decorationsCoroutine
    UnityUiInteractableComponent._buttons
    UnityUiInteractableComponent._isDragging
    UnityUiInteractableComponent._wantsHighlightVisible
    UnityUiInteractableComponent._widthLocked
    UnityUiInteractableComponent.SetupDecorations(bool)
    UnityUiInteractableComponent.AdaptHighlightWidthToText(Image, TMP_Text, RectTransform, float, bool, bool, GameObject)
    UnityUiInteractableComponent.GetHighlightTargetWidth(Image, TMP_Text, RectTransform, float, bool, bool, GameObject)
    UnityUiInteractableComponent.RelocateHighlightImage(Image, TMP_Text, RectTransform, RectTransform)
    UnityUiInteractableComponent.GetHighlightImage(Image, TMP_Text, RectTransform)
    UnityUiInteractableComponent.SetWidthLocked(bool)
    UnityUiInteractableComponent.IsWidthLocked()
    UnityUiInteractableComponent.SetAutoDecorationsEnabled(bool)
    UnityUiInteractableComponent.GetDecorationsPassVersion()
    UnityUiInteractableComponent.RunDecorations(bool)
    UnityUiInteractableComponent.CalculateLogicalWidth()
    UnityUiInteractableComponent.Awake()
    UnityUiInteractableComponent.OnDisable()
    UnityUiInteractableComponent.RefreshLayoutAfterTextChange()
    UnityUiInteractableComponent.IncrementValue()
    UnityUiInteractableComponent.DecrementValue()
    UnityUiInteractableComponent.SetIndex(int)
    UnityUiInteractableComponent.GetIndex()
    UnityUiInteractableComponent.SetIsDragging(bool)
    UnityUiInteractableComponent.GetIsDragging()
    UnityUiInteractableComponent.OnDraggingStart()
    UnityUiInteractableComponent.OnDraggingEnd()
    UnityUiInteractableComponent.Focus()
    UnityUiInteractableComponent.Blur()
    UnityUiInteractableComponent.SelectNextComponent()
    UnityUiInteractableComponent.SelectPreviousComponent()
    UnityUiInteractableComponent.SelectComponentById(string)
    UnityUiInteractableComponent.SetFocus(bool)
    UnityUiInteractableComponent.Initialize(IUiComponentParameters, IUiComponentActions, ILogService)
    UnityUiInteractableComponent.SetFocusAnimation()
    UnityUiInteractableComponent.SetDeselectedAnimation()
    UnityUiInteractableComponent.Cancel()
    UnityUiInteractableComponent.MapTMPAlignment(UiComponentAlignmentType)
    UnityUiInteractableComponent.InitializeLabel(string)
    UnityUiInteractableComponent.InitializeVisualElement(UiComponentInteractionType, UiComponentAlignmentType, float, string)
    UnityUiInteractableComponent.InitializeHighlight()
    UnityUiInteractableComponent.AlignElements(UiComponentInteractionType, UiComponentAlignmentType)
    UnityUiInteractableComponent.SetHighlightAlignment(UiComponentAlignmentType)
    UnityUiInteractableComponent.SetLabelAlignment(UiComponentAlignmentType)
    UnityUiInteractableComponent.HandleCenterAlignment(TMP_Text)
    UnityUiInteractableComponent.FlipHorizontally(GameObject)
    UnityUiInteractableComponent.SetValueAlignment(UiComponentInteractionType, UiComponentAlignmentType)
    UnityUiInteractableComponent.InitializeMirroring(UiComponentAlignmentType)
    UnityUiInteractableComponent.SetButtonAlignment(UiComponentAlignmentType)
    UnityUiInteractableComponent.SetElementPosition(float, UiComponentAlignmentType)
    UnityUiInteractableComponent.GetContentWrapperGameObject()
    UnityUiInteractableComponent.SetContentWrapperGameObject(GameObject)
    UnityUiInteractableComponent.GetLabelElement()
    UnityUiInteractableComponent.GetLabelGameObject()
    UnityUiInteractableComponent.SetLabelGameObject(GameObject)
    UnityUiInteractableComponent.SetLabelElement(IFoundationViewElement)
    UnityUiInteractableComponent.GetMainButtonElement()
    UnityUiInteractableComponent.SetMainButtonGameObject(GameObject)
    UnityUiInteractableComponent.GetMainButtonGameObject()
    UnityUiInteractableComponent.SetMainButtonElement(IFoundationViewElement)
    UnityUiInteractableComponent.SetHighlightGameObject(GameObject)
    UnityUiInteractableComponent.GetHighlightElement()
    UnityUiInteractableComponent.GetHighlightGameObject()
    UnityUiInteractableComponent.SetHighlightElement(IFoundationViewElement)
    UnityUiInteractableComponent.GetValueElement()
    UnityUiInteractableComponent.SetValueGameObject(GameObject)
    UnityUiInteractableComponent.GetValueGameObject()
    UnityUiInteractableComponent.SetValueElement(IFoundationViewElement)
    UnityUiInteractableComponent.SetLabelText(string)
    UnityUiInteractableComponent.SetValueText(string)
    UnityUiInteractableComponent.GetButtonElements(bool)
    UnityUiInteractableComponent.GetButtonGameObjects(bool)
    UnityUiInteractableComponent.SetButtonElements(List<IFoundationViewElement>)
    UnityUiInteractableComponent.GetUiComponentInteractionType()
    UnityUiInteractableComponent.SetUiComponentInteractionType(UiComponentInteractionType)
    UnityUiInteractableComponent.InitializeButtons()
    UnityUiInteractableComponent._decorationsInitialized
    UnityUiInteractableComponent.InteractableParameters
    UnityUiInteractableComponent.InteractableActions
    UnityUiInteractableComponent.DecorationsReady
    UnityUiComponent._animators
    UnityUiComponent.UpdateUiElement<T>(Action<T>, IFoundationViewElement)
    Namespace: Serenity.Ui.Infrastructure.Components
    Assembly: Serenity.UnityUi.Infrastructure.dll
    Syntax
    public class UnityUiSubmitComponent : UnityUiInteractableComponent, IUiInteractable, IUiComponent, IUiSubmittable, IComponent, IFoundationSettings

    Constructors

    UnityUiSubmitComponent()

    Initializes a new Unity UI submit component with submit interaction type.
    Sets up the component for button submission operations within the UI system.

    Declaration
    public UnityUiSubmitComponent()

    Properties

    SubmittableActions

    Gets or sets the submittable actions interface for handling submit events.
    Manages callbacks for submission interactions and button activation events.

    Declaration
    public IUiSubmittableActions SubmittableActions { get; set; }
    Property Value
    Type Description
    IUiSubmittableActions

    The submittable actions interface

    Methods

    InitializeVisualElement()

    Initializes the visual element components and event listeners for the submit component.
    Configures button text, text alignment, and layout group settings based on component parameters.
    Maps foundation alignment types to Unity-specific alignment configurations.

    Declaration
    public override void InitializeVisualElement()
    Overrides
    UnityUiInteractableComponent.InitializeVisualElement()

    OnEnable()

    Unity lifecycle method called when the component is enabled.
    Initiates selector width adaptation setup and visual element initialization if configured.
    Starts coroutines for dynamic selector decoration and button reselection.

    Declaration
    public override void OnEnable()
    Overrides
    UnityUiInteractableComponent.OnEnable()

    SetValue(string)

    Sets the display value of the submit component, updating the button text if available.
    Updates the TextMeshPro text component within the button to display the specified value.

    Declaration
    public override void SetValue(string value)
    Parameters
    Type Name Description
    string value

    The text value to display on the button

    Overrides
    UnityUiInteractableComponent.SetValue(string)

    Submit()

    Performs the submit action and triggers the associated submit events.
    Calls base submit functionality and invokes submittable action callbacks for comprehensive submission handling.

    Declaration
    public override void Submit()
    Overrides
    UnityUiInteractableComponent.Submit()

    Implements

    IUiInteractable
    IUiComponent
    IUiSubmittable
    IComponent
    IFoundationSettings
    In this article
    © 2026 Serenity. All Rights Reserved