Webiant Logo Webiant Logo
☌

  1. No results found.

    Try your search with a different keyword or use * as a wildcard.

FilterParameter.cs

namespace Nop.Web.Framework.Models.DataTables;

/// <summary>
/// Represent DataTables filter parameter
/// </summary>
public partial class FilterParameter
{
    #region Ctor

    /// <summary>
    /// Initializes a new instance of the FilterParameter class by default as string type parameter
    /// </summary>
    /// <param name="name">Filter parameter name</param>
    public FilterParameter(string name)
    {
        Name = name;
        Type = typeof(string);
    }

    /// <summary>
    /// Initializes a new instance of the FilterParameter class
    /// </summary>
    /// <param name="name">Filter parameter name</param>
    /// <param name="modelName">Filter parameter model name</param>
    public FilterParameter(string name, string modelName)
    {
        Name = name;
        ModelName = modelName;
        Type = typeof(string);
    }

    /// <summary>
    /// Initializes a new instance of the FilterParameter class
    /// </summary>
    /// <param name="name">Filter parameter name</param>
    /// <param name="type">Filter parameter type</param>
    public FilterParameter(string name, Type type)
    {
        Name = name;
        Type = type;
    }

    /// <summary>
    /// Initializes a new instance of the FilterParameter class
    /// </summary>
    /// <param name="name">Filter parameter name</param>
    /// <param name="value">Filter parameter value</param>
    public FilterParameter(string name, object value)
    {
        Name = name;
        Type = value.GetType();
        Value = value;
    }

    /// <summary>
    /// Initializes a new instance of the FilterParameter class for linking "parent-child" tables
    /// </summary>
    /// <param name="name">Filter parameter name</param>
    /// <param name="parentName">Filter parameter parent name</param>
    /// <param name="isParentChildParameter">Parameter indicator for linking "parent-child" tables</param>
    public FilterParameter(string name, string parentName, bool isParentChildParameter = true)
    {
        Name = name;
        ParentName = parentName;
        Type = typeof(string);
    }

    #endregion

    #region Properties

    /// <summary>
    /// Filter field name
    /// </summary>
    public string Name { get; }

    /// <summary>
    /// Filter model name
    /// </summary>
    public string ModelName { get; }

    /// <summary>
    /// Filter field type
    /// </summary>
    public Type Type { get; }

    /// <summary>
    /// Filter field value
    /// </summary>
    public object Value { get; set; }

    /// <summary>
    /// Filter field parent name
    /// </summary>
    public string ParentName { get; set; }

    #endregion
}