logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class UiInteractableComponentParameters

    Implementation of IUiInteractableComponentParameters to hold parameters for UI interactable components.

    Inheritance
    object
    UiComponentParameters
    UiInteractableComponentParameters
    UiSelectableParameters
    UiSlideableParameters
    Implements
    IUiComponentParameters
    IUiInteractableParameters
    IComponentParameters
    IFoundationSettings
    Inherited Members
    UiComponentParameters.Id
    UiComponentParameters.Guid
    UiComponentParameters.FoundationViewElementFactory
    UiComponentParameters.AudioPlayerPlayClip
    UiComponentParameters.AudioServiceId
    UiComponentParameters.ThemeSounds
    UiComponentParameters.Clone()
    UiComponentParameters.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Serenity.Ui.Application.Components
    Assembly: Serenity.Ui.Application.dll
    Syntax
    public class UiInteractableComponentParameters : UiComponentParameters, IUiComponentParameters, IUiInteractableParameters, IComponentParameters, IFoundationSettings

    Constructors

    UiInteractableComponentParameters()

    Initializes a new instance of the UiInteractableComponentParameters class with default values.

    Declaration
    public UiInteractableComponentParameters()

    UiInteractableComponentParameters(string, int, string, UiComponentAlignmentType)

    Initializes a new instance of the UiInteractableComponentParameters class with the specified parameters.

    Declaration
    public UiInteractableComponentParameters(string id, int index, string label, UiComponentAlignmentType alignment)
    Parameters
    Type Name Description
    string id

    The unique identifier for the UI interactable component.

    int index

    The index of the UI component.

    string label

    The label of the UI component.

    UiComponentAlignmentType alignment

    The alignment of the UI component.

    UiInteractableComponentParameters(string, string, int, string, UiComponentAlignmentType, IFoundationViewElementFactory, AudioPlayerPlayClip, string, IUiThemeSounds, bool, bool, float)

    Initializes a new instance of the UiInteractableComponentParameters class with the specified parameters.

    Declaration
    public UiInteractableComponentParameters(string id, string guid, int index, string label, UiComponentAlignmentType alignment, IFoundationViewElementFactory foundationViewElementFactory, AudioPlayerPlayClip audioPlayerPlayClip, string audioServiceId, IUiThemeSounds uiThemeSounds, bool isTranslatingLabel, bool adaptMenuWidth, float adaptMenuWidthPadding)
    Parameters
    Type Name Description
    string id

    The unique identifier for the UI interactable component.

    string guid

    The globally unique identifier (GUID) for the UI interactable component.

    int index

    The index of the UI component.

    string label

    The label of the UI component.

    UiComponentAlignmentType alignment

    The alignment of the UI component.

    IFoundationViewElementFactory foundationViewElementFactory

    The factory to create foundation-specific view elements.

    AudioPlayerPlayClip audioPlayerPlayClip

    The action to play audio clips.

    string audioServiceId

    The identifier for the audio service to be used.

    IUiThemeSounds uiThemeSounds

    The theme sounds for the UI component.

    bool isTranslatingLabel

    Whether the label is being translated.

    bool adaptMenuWidth

    Whether to adapt highlight width to text content.

    float adaptMenuWidthPadding

    Padding to apply when adapting highlight width to text content.

    Fields

    AdaptMenuWidth

    Declaration
    public bool AdaptMenuWidth
    Field Value
    Type Description
    bool

    Whether to adapt menu width to text content.

    AdaptMenuWidthPadding

    Declaration
    public float AdaptMenuWidthPadding
    Field Value
    Type Description
    float

    Padding to apply when adapting menu width to text content.

    Alignment

    Declaration
    public UiComponentAlignmentType Alignment
    Field Value
    Type Description
    UiComponentAlignmentType

    The alignment of the UI component.

    DeselectAnimationTrigger

    Declaration
    public string DeselectAnimationTrigger
    Field Value
    Type Description
    string

    Optional animator trigger name for deselection animation.

    Index

    Declaration
    public int Index
    Field Value
    Type Description
    int

    The index of the UI component.

    IsTranslatingLabel

    Declaration
    public bool IsTranslatingLabel
    Field Value
    Type Description
    bool

    Whether the label is being translated.

    Label

    Declaration
    public string Label
    Field Value
    Type Description
    string

    The label of the UI component.

    SelectAnimationTrigger

    Declaration
    public string SelectAnimationTrigger
    Field Value
    Type Description
    string

    Optional animator trigger name for selection animation.

    Implements

    IUiComponentParameters
    IUiInteractableParameters
    IComponentParameters
    IFoundationSettings
    In this article
    © 2026 Serenity. All Rights Reserved