ArcGIS Pro 3.1 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / StyleHelper Class / SearchLegends Method
The StyleProjectItem to search.
The search term.
Example

In This Topic
    SearchLegends Method
    In This Topic
    Returns a collection of legend style items that satisfy the search criteria. This method must be called on the MCT. Use QueuedTask.Run.
    Syntax

    Parameters

    styleProjectItem
    The StyleProjectItem to search.
    searchString
    The search term.

    Return Value

    A collection of LegendStyleItem.
    Exceptions
    ExceptionDescription
    This method must be called within the lambda passed to QueuedTask.Run
    Example
    How to search for legends in a style
    public Task<IList<LegendStyleItem>> GetLegendFromStyleAsync(StyleProjectItem style, string searchString)
    {
      if (style == null)
        throw new System.ArgumentNullException();
    
      return QueuedTask.Run(() => style.SearchLegends(searchString));
    }
    Requirements

    Target Platforms: Windows 11, Windows 10

    ArcGIS Pro version: 3.0 or higher.
    See Also