Class SearchExtensions

Class for Search extension methods

Inheritance

System.Object

SearchExtensions

Namespace: Microsoft.SharePoint.Client

Assembly: PnP.Framework.dll

Syntax

public static class SearchExtensions : object

Methods

DeleteSearchConfiguration(Site, String)

Delete the search configuration - does not apply to managed properties.

Declaration

public static void DeleteSearchConfiguration(this Site site, string searchConfiguration)

Parameters

Site site A SharePoint site

System.String searchConfiguration search configuration

DeleteSearchConfiguration(Web, String)

Delete the search configuration - does not apply to managed properties.

Declaration

public static void DeleteSearchConfiguration(this Web web, string searchConfiguration)

Parameters

Web web A SharePoint site/subsite

System.String searchConfiguration search configuration

DeleteSearchSettings(ClientContext, String, SearchObjectLevel)

Delete search settings from configuration xml.

Declaration

public static void DeleteSearchSettings(this ClientContext context, string searchConfiguration, SearchObjectLevel searchSettingsImportLevel)

Parameters

ClientContext context Context for SharePoint objects and operations

System.String searchConfiguration Search schema xml file path

SearchObjectLevel searchSettingsImportLevel Search settings import level Reference: http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.search.administration.searchobjectlevel(v=office.15).aspx

ExportSearchSettings(ClientContext, String, SearchObjectLevel)

Exports the search settings to file.

Declaration

public static void ExportSearchSettings(this ClientContext context, string exportFilePath, SearchObjectLevel searchSettingsExportLevel)

Parameters

ClientContext context Context for SharePoint objects and operations

System.String exportFilePath Path where to export the search settings

SearchObjectLevel searchSettingsExportLevel Search settings export level Reference: http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.search.administration.searchobjectlevel(v=office.15).aspx

GetSearchConfiguration(Site)

Returns the current search configuration as as string

Declaration

public static string GetSearchConfiguration(this Site site)

Parameters

Site site A SharePoint site

Returns

System.String Returns search configuration

GetSearchConfiguration(Web)

Returns the current search configuration as as string

Declaration

public static string GetSearchConfiguration(this Web web)

Parameters

Web web A SharePoint site/subsiste

Returns

System.String Returns search configuration

GetSiteCollectionSearchCenterUrl(Web)

Get the search center URL for the site collection (Site Settings -> Site collection administration --> Search Settings)

Declaration

public static string GetSiteCollectionSearchCenterUrl(this Web web)

Parameters

Web web SharePoint site - root web

Returns

System.String Search center URL for web

GetWebSearchCenterUrl(Web, Boolean)

Get the search results page URL for the web (Site Settings -> Search --> Search Settings)

Declaration

public static string GetWebSearchCenterUrl(this Web web, bool urlOnly = false)

Parameters

Web web SharePoint site - current web

System.Boolean urlOnly Allows to declare to return the URL only and not the full JSON settings

Returns

System.String Search results page URL for web

ImportSearchSettings(ClientContext, String, SearchObjectLevel)

Imports search settings from file.

Declaration

public static void ImportSearchSettings(this ClientContext context, string searchSchemaImportFilePath, SearchObjectLevel searchSettingsImportLevel)

Parameters

ClientContext context Context for SharePoint objects and operations

System.String searchSchemaImportFilePath Search schema xml file path

SearchObjectLevel searchSettingsImportLevel Search settings import level Reference: http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.search.administration.searchobjectlevel(v=office.15).aspx

ImportSearchSettingsConfiguration(ClientContext, String, SearchObjectLevel)

Imports search settings from configuration xml.

Declaration

public static void ImportSearchSettingsConfiguration(this ClientContext context, string searchConfiguration, SearchObjectLevel searchSettingsImportLevel)

Parameters

ClientContext context Context for SharePoint objects and operations

System.String searchConfiguration Search schema xml file path

SearchObjectLevel searchSettingsImportLevel Search settings import level Reference: http://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.search.administration.searchobjectlevel(v=office.15).aspx

SetSearchBoxPlaceholderText(Site, String, String)

Declaration

public static void SetSearchBoxPlaceholderText(this Site site, string placeholderText, string tenantAdminUrl = null)

Parameters

Site site

System.String placeholderText

System.String tenantAdminUrl

SetSearchBoxPlaceholderText(Web, String, String)

Declaration

public static void SetSearchBoxPlaceholderText(this Web web, string placeholderText, string tenantAdminUrl = null)

Parameters

Web web

System.String placeholderText

System.String tenantAdminUrl

SetSearchConfiguration(Site, String)

Sets the search configuration

Declaration

public static void SetSearchConfiguration(this Site site, string searchConfiguration)

Parameters

Site site A SharePoint site

System.String searchConfiguration search configuration

SetSearchConfiguration(Web, String)

Sets the search configuration

Declaration

public static void SetSearchConfiguration(this Web web, string searchConfiguration)

Parameters

Web web A SharePoint site/subsite

System.String searchConfiguration search configuration

SetSiteCollectionSearchCenterUrl(Web, String, String)

Sets the search center URL on site collection (Site Settings -> Site collection administration --> Search Settings)

Declaration

public static void SetSiteCollectionSearchCenterUrl(this Web web, string searchCenterUrl, string tenantAdminUrl = null)

Parameters

Web web SharePoint site - root web

System.String searchCenterUrl Search center URL

System.String tenantAdminUrl Url to the tenant admin site. Optional. Will try to determine automatically if omitted.

SetWebSearchCenterUrl(Web, String, String)

Sets the search results page URL on current web (Site Settings -> Search --> Search Settings)

Declaration

public static void SetWebSearchCenterUrl(this Web web, string searchCenterUrl, string tenantAdminUrl = null)

Parameters

Web web SharePoint current web

System.String searchCenterUrl Search results page URL

System.String tenantAdminUrl Url to the tenant admin site. Optional. Will try to determine automatically if omitted.