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

C#
Visual Basic (Declaration)

public static IList<LegendStyleItem> SearchLegends( 
   StyleProjectItem styleProjectItem,
   string searchString
)

Public Shared Function SearchLegends( _
   ByVal styleProjectItem As StyleProjectItem, _
   ByVal searchString As String _
) As IList(Of LegendStyleItem)

Parameters

styleProjectItem: The StyleProjectItem to search.
searchString: The search term.

Return Value

A collection of LegendStyleItem.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	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.

Reference

StyleHelper Class
StyleHelper Members

Send feedback