Search Results for

    Show / Hide Table of Contents

    Class SearchOptions

    Defines the search query to make

    Inheritance
    System.Object
    SearchOptions
    Namespace: PnP.Core.Model.SharePoint
    Assembly: PnP.Core.dll
    Syntax
    public class SearchOptions : object

    Constructors

    SearchOptions(String)

    Default constructor

    Declaration
    public SearchOptions(string query)
    Parameters
    System.String query

    Provide the query to issue

    Properties

    ClientType

    Client type used for the search query (defaults to ContentSearchRegular)

    Declaration
    public string ClientType { get; set; }
    Property Value
    System.String

    Query

    Search query to issue

    Declaration
    public string Query { get; }
    Property Value
    System.String

    RefinementFilters

    The set of refinement filters used when issuing a refinement query

    Declaration
    public List<string> RefinementFilters { get; set; }
    Property Value
    PnP.Core.Model.SharePoint.List<System.String>

    RefineProperties

    Properties used to refine the search results

    Declaration
    public List<string> RefineProperties { get; set; }
    Property Value
    PnP.Core.Model.SharePoint.List<System.String>

    ResultSourceId

    Result source id to use for the search query

    Declaration
    public string ResultSourceId { get; set; }
    Property Value
    System.String

    RowLimit

    Max number of rows to return

    Declaration
    public int? RowLimit { get; set; }
    Property Value
    System.Nullable<System.Int32>

    RowsPerPage

    Rows to return per page. Defaults to 500

    Declaration
    public int? RowsPerPage { get; set; }
    Property Value
    System.Nullable<System.Int32>

    SelectProperties

    Properties to select

    Declaration
    public List<string> SelectProperties { get; set; }
    Property Value
    PnP.Core.Model.SharePoint.List<System.String>

    SortProperties

    Properties to sort the query on

    Declaration
    public List<SortOption> SortProperties { get; set; }
    Property Value
    PnP.Core.Model.SharePoint.List<SortOption>

    StartRow

    Start row of the search result set

    Declaration
    public int? StartRow { get; set; }
    Property Value
    System.Nullable<System.Int32>

    TrimDuplicates

    Trim duplicate search results

    Declaration
    public bool TrimDuplicates { get; set; }
    Property Value
    System.Boolean

    Back to top PnP Core SDK
    Generated by DocFX with Material UI
    spacer