logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class UiComponentParameters

    Implementation of IUiComponentParameters to hold parameters for UI components.

    Inheritance
    object
    UiComponentParameters
    UiInteractableComponentParameters
    Implements
    IUiComponentParameters
    IComponentParameters
    IFoundationSettings
    Inherited Members
    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 UiComponentParameters : IUiComponentParameters, IComponentParameters, IFoundationSettings

    Constructors

    UiComponentParameters()

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

    Declaration
    public UiComponentParameters()

    UiComponentParameters(string)

    Initializes a new instance of the UiComponentParameters class with the specified identifier.

    Declaration
    public UiComponentParameters(string id)
    Parameters
    Type Name Description
    string id

    The unique identifier for the UI component.

    UiComponentParameters(string, string, IFoundationViewElementFactory, AudioPlayerPlayClip, string, IUiThemeSounds)

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

    Declaration
    public UiComponentParameters(string id, string guid, IFoundationViewElementFactory foundationViewElementFactory, AudioPlayerPlayClip audioPlayerPlayClip, string audioServiceId, IUiThemeSounds themeSounds)
    Parameters
    Type Name Description
    string id

    The unique identifier for the UI component.

    string guid

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

    IFoundationViewElementFactory foundationViewElementFactory

    The factory for creating foundation view elements.

    AudioPlayerPlayClip audioPlayerPlayClip

    The audio player play clip.

    string audioServiceId

    The identifier for the audio service.

    IUiThemeSounds themeSounds

    The theme sounds associated with the UI component.

    Fields

    AudioPlayerPlayClip

    Declaration
    public AudioPlayerPlayClip AudioPlayerPlayClip
    Field Value
    Type Description
    AudioPlayerPlayClip

    The audio player play clip.

    AudioServiceId

    Declaration
    public string AudioServiceId
    Field Value
    Type Description
    string

    The identifier for the audio service.

    FoundationViewElementFactory

    Declaration
    public IFoundationViewElementFactory FoundationViewElementFactory
    Field Value
    Type Description
    IFoundationViewElementFactory

    The factory for creating foundation view elements.

    Guid

    Declaration
    public string Guid
    Field Value
    Type Description
    string

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

    Id

    Declaration
    public string Id
    Field Value
    Type Description
    string

    The unique identifier for the UI component.

    ThemeSounds

    Declaration
    public IUiThemeSounds ThemeSounds
    Field Value
    Type Description
    IUiThemeSounds

    The theme sounds associated with the UI component.

    Methods

    Clone()

    Creates a deep clone of the current UiComponentParameters instance.

    Declaration
    public UiComponentParameters Clone()
    Returns
    Type Description
    UiComponentParameters

    A new UiComponentParameters instance with the same property values as the current instance.

    ToString()

    Returns a string representation of the UiComponentParameters.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string representation of the instance.

    Overrides
    object.ToString()

    Implements

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