SearchLegendItems Method

In This Topic

Returns a collection of legend item style items that satisfy the search criteria. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Shared Function SearchLegendItems( _
   ByVal styleProjectItem As StyleProjectItem, _
   ByVal searchString As String _
) As IList(Of LegendItemStyleItem)

public static IList<LegendItemStyleItem> SearchLegendItems( 
   StyleProjectItem styleProjectItem,
   string searchString
)

Parameters

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

Return Value

A collection of TableFrameFieldStyleItem.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method must be called within the lambda passed to QueuedTask.Run

Example

How to search for legend items in a style

{
    //Search for legend items
    //Note: styleProjectItem was created above in the variable initialization section
    //Note: Needs QueuedTask to run
    styleProjectItem.SearchLegendItems("searchString");
}

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.0 or higher.

Reference

StyleHelper Class
StyleHelper Members

Send feedback