SearchLegendPatches Method

In This Topic

Returns a collection of line or area legend patch 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<LegendPatchStyleItem> SearchLegendPatches( 
   StyleProjectItem styleProjectItem,
   StyleItemType itemType,
   string searchString
)

Public Shared Function SearchLegendPatches( _
   ByVal styleProjectItem As StyleProjectItem, _
   ByVal itemType As StyleItemType, _
   ByVal searchString As String _
) As IList(Of LegendPatchStyleItem)

Parameters

styleProjectItem: The StyleProjectItem to search.
itemType: The StyleItemType to search for StyleItemType.AreaLegendPatch or StyleItemType.LineLegendPatch
searchString: The search term.

Return Value

A collection of LegendPatchStyleItem.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method must be called within the lambda passed to QueuedTask.Run
System.ArgumentException	Parameter itemType must be of type StyleItemType.AreaLegendPatch or StyleItemType.LineLegendPatch.

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.4 or higher.

Reference

StyleHelper Class
StyleHelper Members

Send feedback