SearchColorRamps Method

Returns a collection of color ramp 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<ColorRampStyleItem> SearchColorRamps( 
   StyleProjectItem styleProjectItem,
   string searchString
)

Public Shared Function SearchColorRamps( _
   ByVal styleProjectItem As StyleProjectItem, _
   ByVal searchString As String _
) As IList(Of ColorRampStyleItem)

Parameters

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

Return Value

A collection of ColorRampStyleItem.

Exceptions

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

Example

public async Task<IList<ColorRampStyleItem>> GetColorRampsFromStyleAsync(StyleProjectItem style, string searchString)
{
  //StyleProjectItem can be "ColorBrewer Schemes (RGB)", "ArcGIS 2D"...
  if (style == null)
    throw new System.ArgumentNullException();

  //Search for color ramps
  //Color Ramp searchString can be "Spectral (7 Classes)", "Pastel 1 (3 Classes)", "Red-Gray (10 Classes)"..
  return await QueuedTask.Run(() => style.SearchColorRamps(searchString));
}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 7

Reference

StyleHelper Class
StyleHelper Members