Search Results for

    Show / Hide Table of Contents

    Class SearchOptions

    Defines the search query to make

    Inheritance
    object
    SearchOptions
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: PnP.Core.Model.SharePoint
    Assembly: PnP.Core.dll
    Syntax
    public class SearchOptions

    Constructors

    SearchOptions(string)

    Default constructor

    Declaration
    public SearchOptions(string query)
    Parameters
    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
    string

    Query

    Search query to issue

    Declaration
    public string Query { get; }
    Property Value
    string

    RefineProperties

    Properties used to refine the search results

    Declaration
    public List<string> RefineProperties { get; set; }
    Property Value
    List<string>

    RefinementFilters

    The set of refinement filters used when issuing a refinement query

    Declaration
    public List<string> RefinementFilters { get; set; }
    Property Value
    List<string>

    ResultSourceId

    Result source id to use for the search query

    Declaration
    public string ResultSourceId { get; set; }
    Property Value
    string

    RowLimit

    Max number of rows to return

    Declaration
    public int? RowLimit { get; set; }
    Property Value
    int?

    RowsPerPage

    Rows to return per page. Defaults to 500

    Declaration
    public int? RowsPerPage { get; set; }
    Property Value
    int?

    SelectProperties

    Properties to select

    Declaration
    public List<string> SelectProperties { get; set; }
    Property Value
    List<string>

    SortProperties

    Properties to sort the query on

    Declaration
    public List<SortOption> SortProperties { get; set; }
    Property Value
    List<SortOption>

    StartRow

    Start row of the search result set

    Declaration
    public int? StartRow { get; set; }
    Property Value
    int?

    TrimDuplicates

    Trim duplicate search results

    Declaration
    public bool TrimDuplicates { get; set; }
    Property Value
    bool

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