Version: 2021.1
LanguageEnglish
  • C#

ShowDetailsOptions

enumeration

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Defines what details are shown in the preview inspector panel for the search view.

.

[SearchItemProvider]
internal static SearchProvider CreateProvider()
{
    return new SearchProvider(id, name)
    {
        active = false,
        filterId = "hex:",
        priority = 99999, // put example provider at a low priority
        showDetailsOptions = ShowDetailsOptions.Description | ShowDetailsOptions.Preview,
        fetchItems = (context, items, provider) =>
        {
            var expression = context.searchQuery;
            if (expression.Length == 6 && IsHex(expression))
            {
                expression = "#" + expression;
                items.Add(provider.CreateItem(context, expression, GetColorName(expression),
                    "Look at this " + GetColorName(expression) + " color!",
                    CreateTextureFromColor(expression, 64, 64), null));
            }
            return null;
        },
        fetchPreview = (item, context, size, options) =>
        {
            return CreateTextureFromColor(item.id, (int)size.x, (int)size.y);
        },
    };
}

Properties

NoneNo options are defined.
PreviewShow a large preview.
InspectorShow an embedded inspector for the selected object.
ActionsShows selected item possible actions.
DescriptionShow an extended item description.
ListViewIndicates that this search provider wants to display its items in a list view if possible.
DefaultGroupIndicates that the provider will always be displayed as a group (tab) even if the result set is empty.
DefaultDefault set of options used when SearchProvider.showDetails is set to true.