docs.unity.cn
    Show / Hide Table of Contents

    Class SceneQueryEngineFilterAttribute

    This is a QueryEngineFilterAttribute use for query in a scene provider.

    Inheritance
    Object
    Attribute
    QueryEngineFilterAttribute
    SceneQueryEngineFilterAttribute
    Inherited Members
    QueryEngineFilterAttribute.token
    QueryEngineFilterAttribute.comparisonOptions
    QueryEngineFilterAttribute.overridesStringComparison
    QueryEngineFilterAttribute.supportedOperators
    QueryEngineFilterAttribute.useParamTransformer
    QueryEngineFilterAttribute.paramTransformerFunction
    QueryEngineFilterAttribute.useRegularExpressionToken
    Namespace: UnityEditor.Search.Providers
    Syntax
    [AttributeUsage(AttributeTargets.Method)]
    public class SceneQueryEngineFilterAttribute : QueryEngineFilterAttribute, _Attribute

    Constructors

    SceneQueryEngineFilterAttribute(String, String, String[])

    Create a filter with the corresponding token, parameter transformer function and supported operators.

    Declaration
    public SceneQueryEngineFilterAttribute(string token, string paramTransformerFunction, string[] supportedOperators = null)
    Parameters
    Type Name Description
    String token

    The identifier of the filter. Typically what precedes the operator in a filter (i.e. "id" in "id>=2").

    String paramTransformerFunction

    Name of the parameter transformer function to use with this filter. Tag the parameter transformer function with the appropriate ParameterTransformer attribute.

    String[] supportedOperators

    List of supported operator tokens. Null for all operators.

    Remarks

    Sets the flag useParamTransformer to true.

    SceneQueryEngineFilterAttribute(String, String, StringComparison, String[])

    Create a filter with the corresponding token, parameter transformer function, string comparison options and supported operators.

    Declaration
    public SceneQueryEngineFilterAttribute(string token, string paramTransformerFunction, StringComparison options, string[] supportedOperators = null)
    Parameters
    Type Name Description
    String token

    The identifier of the filter. Typically what precedes the operator in a filter (i.e. "id" in "id>=2").

    String paramTransformerFunction

    Name of the parameter transformer function to use with this filter. Tag the parameter transformer function with the appropriate ParameterTransformer attribute.

    StringComparison options

    String comparison options.

    String[] supportedOperators

    List of supported operator tokens. Null for all operators.

    Remarks

    Sets both overridesStringComparison and useParamTransformer flags to true.

    SceneQueryEngineFilterAttribute(String, String[])

    Create a filter with the corresponding token and supported operators.

    Declaration
    public SceneQueryEngineFilterAttribute(string token, string[] supportedOperators = null)
    Parameters
    Type Name Description
    String token

    The identifier of the filter. Typically what precedes the operator in a filter (i.e. "id" in "id>=2").

    String[] supportedOperators

    List of supported operator tokens. Null for all operators.

    SceneQueryEngineFilterAttribute(String, StringComparison, String[])

    Create a filter with the corresponding token, string comparison options and supported operators.

    Declaration
    public SceneQueryEngineFilterAttribute(string token, StringComparison options, string[] supportedOperators = null)
    Parameters
    Type Name Description
    String token

    The identifier of the filter. Typically what precedes the operator in a filter (i.e. "id" in "id>=2").

    StringComparison options

    String comparison options.

    String[] supportedOperators

    List of supported operator tokens. Null for all operators.

    Remarks

    This sets the flag overridesStringComparison to true.

    Back to top Copyright © 2022 Unity Technologies
    Generated by DocFX
    on Wednesday, October 26, 2022
    Terms of use