ArcGIS Pro 3.3 API Reference Guide
ArcGIS.Desktop.Core Namespace / Project Class / SearchAsync Method
Search criteria specifying the items you want to find

In This Topic
    SearchAsync Method
    In This Topic
    Searches the project for items that match the provided criteria
    Syntax
    public Task<IEnumerable<Item>> SearchAsync( 
       string query
    )
    Public Function SearchAsync( _
       ByVal query As String _
    ) As Task(Of IEnumerable(Of Item))

    Parameters

    query
    Search criteria specifying the items you want to find

    Return Value

    A Task returning a collection of Item
    Remarks

    When items are added to the project, they are indexed immediately by default. If you open a project created by someone else, indexing starts when a new item is added to the project or the first time you try to search for items in the project. Items can be searched as soon as indexing is complete. When you search the current project, only items associated with the current project are searched.

    When items are indexed, their type, file name, title, tags, summary, description, credits, use limitations, and a few properties are recorded in a Lucene index that is stored on the local machine. These may be derived from the item's metadata, if it exists.

    The search criteria may be a general set of keywords specifying what you are looking for, like when you search for information on the internet. These keywords can reflect the properties of the item or information provided in its metadata, such as "excel table" or "national park". You can refine the search by specifying only the fields in which to look for the specified word or phrase. For example, to search for a word only in the item's set of tags, specify the criteria "tags:park", or in the summary "summary:aristida purpurea species"

    Requirements

    Target Platforms: Windows 11, Windows 10

    ArcGIS Pro version: 3 or higher.
    See Also