Version: 2022.3
LanguageEnglish
  • C#

SearchItemOptions

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

Indicates how the search item description needs to be formatted when presented to the user.

private static SearchItem SearchLogEntry(SearchContext context, SearchProvider provider, LogEntry logEntry)
{
    if (!SearchUtils.MatchSearchGroups(context, logEntry.msgLowerCased, true))
        return null;

    var logItem = provider.CreateItem(context, logEntry.id, ~logEntry.lineNumber, logEntry.msg, null, null, logEntry);
    logItem.options = SearchItemOptions.Ellipsis | SearchItemOptions.RightToLeft | SearchItemOptions.Highlight;
    return logItem;
}

Properties

NoneUses default description.
EllipsisIf the description is longer than the width of the search view, truncates the description and adds an ellipsis.
RightToLeftIf the description is longer than the search view, keeps the last characters.
HighlightHighlights parts of the description that match the Search Query.
FuzzyHighlightHighlights parts of the description that match the Fuzzy Search Query.
CompactedUses Label instead of description for shorter display.
AlwaysRefreshIndicates that the item will always be refreshed.
FullDescriptionThe item description that is displayed in full mode. This is usually the case when the description is displayed in the Preview Inspector as opposed to the Result View.
CustomActionIndicates that the item is used as a built-in or custom user action that should always be displayed on top of result views.