ContentBySearchWebPart members
The ContentBySearchWebPart is a Web Part introduced in SharePoint Server 2013 that can display dynamic content that was previously crawled and added to the search index.
Each Web Part instance is associated with a search query and shows the results for that particular search query. When users browse to a page that contains a ContentBySearchWebPart, the search query is automatically issued and the corresponding search results are returned from the search index.
You can use display templates, which are snippets of HTML and JavaScript, to change how search results appear on the page. Display templates render information returned by SharePoint; the information is inserted into the page in JSON format.
The ContentBySearchWebPart type exposes the following members.
Constructors
Name | Description | |
---|---|---|
ContentBySearchWebPart | Constructs a Web Part that renders dynamic content extracted from the search index. |
Top
Properties
Name | Description | |
---|---|---|
AccessKey | (Inherited from WebControl.) | |
ActiveDataProvider | (Inherited from DisplayScriptWebPart.) | |
Adapter | (Inherited from Control.) | |
AddSEOPropertiesFromSearch | Specifies properties to be used for search engines; these properties will optimize the crawlers and improve SEO. | |
AdvancedSearchPageAddress | (Inherited from ResultScriptWebPart.) | |
AllowClose | (Inherited from WebPart.) | |
AllowConnect | (Inherited from WebPart.) | |
AllowEdit | (Inherited from WebPart.) | |
AllowHide | (Inherited from WebPart.) | |
AllowMinimize | (Inherited from WebPart.) | |
AllowRemove | Obsolete. (Inherited from WebPart.) | |
AllowZoneChange | (Inherited from WebPart.) | |
AlternateErrorMessage | Gets or sets the alternate visitor error message to show. (Inherited from ScriptWebPart.) | |
AlwaysRenderOnServer | A Boolean value that forces the Web Part to render on the server side. Otherwise, the Web Part will be rendered on the client side using Ajax. | |
AppManager | (Inherited from ScriptWebPart.) | |
AppRelativeTemplateSourceDirectory | (Inherited from Control.) | |
Attributes | (Inherited from WebControl.) | |
AuthorizationFilter | (Inherited from WebPart.) | |
AvailableSorts | List of available sort options (Inherited from ResultScriptWebPart.) | |
AvailableSortsJson | (Inherited from ResultScriptWebPart.) | |
BackColor | (Inherited from WebControl.) | |
BackImageUrl | (Inherited from Panel.) | |
BindingContainer | (Inherited from Control.) | |
BorderColor | (Inherited from WebControl.) | |
BorderStyle | (Inherited from WebControl.) | |
BorderWidth | (Inherited from WebControl.) | |
BrowserDesignMode | Obsolete. (Inherited from WebPart.) | |
BypassResultTypes | (Inherited from ResultScriptWebPart.) | |
CacheType | (Inherited from WebPart.) | |
Caption | Obsolete. (Inherited from WebPart.) | |
CatalogIconImageUrl | (Inherited from WebPart.) | |
ChildControlsCreated | (Inherited from Control.) | |
ChromeState | (Inherited from WebPart.) | |
ChromeType | (Inherited from WebPart.) | |
ClassResourcePath | (Inherited from WebPart.) | |
ClientControlType | Gets the client control type of the current control. (Inherited from ScriptWebPart.) | |
ClientID | (Inherited from Control.) | |
ClientIDMode | (Inherited from Control.) | |
ClientIDSeparator | (Inherited from Control.) | |
ClientName | (Inherited from WebPart.) | |
ConnectErrorMessage | (Inherited from WebPart.) | |
ConnectionID | (Inherited from WebPart.) | |
Connections | (Inherited from WebPart.) | |
ContainerWidth | Obsolete. (Inherited from WebPart.) | |
Context | (Inherited from Control.) | |
Controls | (Inherited from Part.) | |
ControlStyle | (Inherited from WebControl.) | |
ControlStyleCreated | (Inherited from WebControl.) | |
CsrContainerId | (Inherited from ScriptWebPart.) | |
CssClass | (Inherited from WebControl.) | |
CssStyleSheet | (Inherited from WebPart.) | |
DataItemContainer | (Inherited from Control.) | |
DataKeysContainer | (Inherited from Control.) | |
DataProviderJSON | JSON serialized version of the data provider (Inherited from ResultScriptWebPart.) | |
DefaultAvailableSorts | Specifies the default sort options available. (Overrides ResultScriptWebPart.DefaultAvailableSorts.) | |
DefaultButton | (Inherited from Panel.) | |
DefaultItemBodyTemplateId | Specifies the identifier (ID) for the item’s default body template. (Overrides ResultScriptWebPart.DefaultItemBodyTemplateId.) | |
DefaultPreloadedItemTemplateIds | Specifies the identifiers (IDs) for the item’s default preloaded templates. (Overrides ResultScriptWebPart.DefaultPreloadedItemTemplateIds.) | |
DelayLoadTemplateScripts | (Inherited from DisplayScriptWebPart.) | |
Description | (Inherited from WebPart.) | |
DesignMode | (Inherited from Control.) | |
DetailLink | Obsolete. (Inherited from WebPart.) | |
Dir | Obsolete. (Inherited from WebPart.) | |
Direction | (Inherited from WebPart.) | |
DisplayTitle | (Inherited from WebPart.) | |
EffectiveFrameType | Obsolete. (Inherited from WebPart.) | |
EffectiveStorage | (Inherited from WebPart.) | |
EffectiveTitle | (Inherited from WebPart.) | |
EmitStyleReference | (Inherited from ScriptWebPart.) | |
EmptyMessage | (Inherited from DisplayScriptWebPart.) | |
Enabled | (Inherited from WebControl.) | |
EnableTheming | (Inherited from WebControl.) | |
EnableViewState | (Inherited from Control.) | |
Events | (Inherited from Control.) | |
ExportControlledProperties | Obsolete. (Inherited from WebPart.) | |
ExportMode | (Inherited from WebPart.) | |
Font | (Inherited from WebControl.) | |
ForeColor | (Inherited from WebControl.) | |
FrameState | Obsolete. (Inherited from WebPart.) | |
FrameType | Obsolete. (Inherited from WebPart.) | |
GroupingText | (Inherited from Panel.) | |
GroupTemplateId | (Inherited from ResultScriptWebPart.) | |
HasAttributes | (Inherited from WebControl.) | |
HasChildViewState | (Inherited from Control.) | |
HasSharedData | (Inherited from WebPart.) | |
HasUserData | (Inherited from WebPart.) | |
Height | (Inherited from WebPart.) | |
HelpLink | Obsolete. (Inherited from WebPart.) | |
HelpMode | (Inherited from WebPart.) | |
HelpUrl | (Inherited from WebPart.) | |
Hidden | (Inherited from WebPart.) | |
HitHighlightedProperties | List of hit highlighted properties (Inherited from ResultScriptWebPart.) | |
HitHighlightedPropertiesJson | (Inherited from ResultScriptWebPart.) | |
HorizontalAlign | (Inherited from Panel.) | |
ID | (Inherited from WebPart.) | |
IdSeparator | (Inherited from Control.) | |
ImportErrorMessage | (Inherited from WebPart.) | |
IncludeResultTypeConstraint | For internal use only. | |
IsChildControlStateCleared | (Inherited from Control.) | |
IsClosed | (Inherited from WebPart.) | |
IsEnabled | (Inherited from WebControl.) | |
IsIncluded | Obsolete. (Inherited from WebPart.) | |
IsIncludedFilter | Obsolete. (Inherited from WebPart.) | |
IsPageInEditMode | (Inherited from ScriptWebPart.) | |
IsShared | (Inherited from WebPart.) | |
IsStandalone | (Inherited from WebPart.) | |
IsStatic | (Inherited from WebPart.) | |
IsTrackingViewState | (Inherited from Control.) | |
IsViewStateEnabled | (Inherited from Control.) | |
IsVisible | Obsolete. (Inherited from WebPart.) | |
ItemBodyTemplateId | (Inherited from ResultScriptWebPart.) | |
ItemTemplateId | (Inherited from ResultScriptWebPart.) | |
LoadViewStateByID | (Inherited from Control.) | |
LogAnalyticsViewEvent | Specifies whether the data should be sent to the analytics processing component. | |
MaxPagesAfterCurrent | Specify the maximum number of pages after the current page of results for which to display paging links (Inherited from ResultScriptWebPart.) | |
MaxPagesBeforeCurrent | Specify the maximum number of pages before the current page of results for which to display paging links (Inherited from ResultScriptWebPart.) | |
Messages | Gets the list of error and information messages for the current Web Part. (Inherited from ScriptWebPart.) | |
MissingAssembly | Obsolete. (Inherited from WebPart.) | |
NamingContainer | (Inherited from Control.) | |
NumberOfItems | Specifies the number of items that should be displayed from the search results. The default value is 3. | |
OverflowAuto | (Inherited from WebPart.) | |
OverwriteResultPath | Specifies whether the Web Part should allow result URLs to be rewritten as friendly URLs. | |
Page | (Inherited from Control.) | |
Parent | (Inherited from Control.) | |
PartImageLarge | Obsolete. (Inherited from WebPart.) | |
PartImageSmall | Obsolete. (Inherited from WebPart.) | |
PartOrder | Obsolete. (Inherited from WebPart.) | |
Permissions | Obsolete. (Inherited from WebPart.) | |
PreloadedItemTemplateIds | (Inherited from ResultScriptWebPart.) | |
PreloadedItemTemplateIdsJson | (Inherited from ResultScriptWebPart.) | |
PropertyMappings | Specifies the mappings of managed properties for fields in the display template. | |
Qualifier | (Inherited from WebPart.) | |
QueryGroup | (Inherited from DisplayScriptWebPart.) | |
QueryGroupName | Name of the query group to which this webpart belongs (Inherited from DisplayScriptWebPart.) | |
RenderingCompatibility | (Inherited from Control.) | |
RenderTemplateId | Gets or sets the control render template name. (Inherited from ScriptWebPart.) | |
RepositionLanguageDropDown | Whether to reposition the language dropdown (Inherited from ResultScriptWebPart.) | |
ResultsPerPage | Number of results to display (Inherited from ResultScriptWebPart.) | |
ResultType | For internal use only. | |
ResultTypeId | (Inherited from ResultScriptWebPart.) | |
SaveProperties | (Inherited from WebPart.) | |
ScriptSerializer | (Inherited from ScriptWebPart.) | |
ScrollBars | (Inherited from Panel.) | |
ScrollToTopOnRedraw | (Inherited from ResultScriptWebPart.) | |
SelectedProperties | List of properties to return with query results (Inherited from ResultScriptWebPart.) | |
SelectedPropertiesJson | (Inherited from ResultScriptWebPart.) | |
SerializeAll | (Inherited from WebPart.) | |
SerializedAttachedPropertiesShared | (Inherited from WebPart.) | |
SerializedAttachedPropertiesUser | (Inherited from WebPart.) | |
ServerIncludeScripts | Gets or sets the list of scripts to be included by the server Web Part. (Inherited from ScriptWebPart.) | |
ServerIncludeScriptsJson | (Inherited from ScriptWebPart.) | |
ServerRelativeClassResourcePath | (Inherited from WebPart.) | |
ShouldHideControlWhenEmpty | Specifies whether the control should be displayed if there are no results available. | |
ShouldSearchForTemplateSelectedPropsValue | (Overrides ResultScriptWebPart.ShouldSearchForTemplateSelectedPropsValue.) | |
ShouldValidate | (Inherited from WebPart.) | |
ShowAdvancedLink | Whether to show advanced search link (Inherited from ResultScriptWebPart.) | |
ShowAlertMe | Controls whether to show the alerts creation link. (Inherited from ResultScriptWebPart.) | |
ShowBestBets | Whether to show best bet results (Inherited from ResultScriptWebPart.) | |
ShowDataErrors | (Inherited from ScriptWebPart.) | |
ShowDefinitions | Whether to show discovered definitions (Inherited from ResultScriptWebPart.) | |
ShowDidYouMean | Whether to show Did You Mean result (Inherited from ResultScriptWebPart.) | |
ShowLanguageOptions | Whether to show query language optoins (Inherited from ResultScriptWebPart.) | |
ShowPaging | Whether to show paging controls (Inherited from ResultScriptWebPart.) | |
ShowPersonalFavorites | Whether to show best bet results (Inherited from ResultScriptWebPart.) | |
ShowPreferencesLink | Whether to show preferences link (Inherited from ResultScriptWebPart.) | |
ShowResultCount | Whether to show result count (Inherited from ResultScriptWebPart.) | |
ShowResults | Whether to show relevance results (Inherited from ResultScriptWebPart.) | |
ShowSortOptions | Whether to show sort optoins (Inherited from ResultScriptWebPart.) | |
ShowUpScopeMessage | (Inherited from ResultScriptWebPart.) | |
ShowViewDuplicates | (Inherited from ResultScriptWebPart.) | |
Site | (Inherited from Control.) | |
SkinID | (Inherited from WebControl.) | |
StartingItemIndex | Specifies the index at which to start the display of search results. The default value is 1. | |
States | Gets or sets the custom states passed as-is to the control. (Inherited from ScriptWebPart.) | |
StatesJson | (Inherited from ScriptWebPart.) | |
StorageKey | (Inherited from WebPart.) | |
Style | (Inherited from WebControl.) | |
Subtitle | (Inherited from WebPart.) | |
SupportsDisabledAttribute | (Inherited from Panel.) | |
SuppressWebPartChrome | (Inherited from WebPart.) | |
TabIndex | (Inherited from WebControl.) | |
TagKey | (Inherited from WebControl.) | |
TagName | (Inherited from WebControl.) | |
TargetResultTable | Specifies the target ResultTable to display. | |
TemplateControl | (Inherited from Control.) | |
TemplateSourceDirectory | (Inherited from Control.) | |
Title | (Inherited from WebPart.) | |
TitleIconImageUrl | (Inherited from WebPart.) | |
TitleUrl | (Inherited from WebPart.) | |
ToolTip | (Inherited from WebControl.) | |
UniqueID | (Inherited from Control.) | |
UnknownXmlElements | (Inherited from WebPart.) | |
UseDefaultStyles | (Inherited from WebPart.) | |
UseSharedDataProvider | Indicates if the web part is sharing a data provider from another web part (Inherited from ResultScriptWebPart.) | |
UseSimplifiedQueryBuilder | This property is used to display a lighter version of the query builder. It is used by the webparts that are preconfigured for a system result source (Inherited from ResultScriptWebPart.) | |
Verbs | (Inherited from WebPart.) | |
ViewState | (Inherited from Control.) | |
ViewStateIgnoresCase | (Inherited from Control.) | |
ViewStateMode | (Inherited from Control.) | |
Visible | (Inherited from Control.) | |
WebBrowsableObject | (Inherited from WebPart.) | |
WebPartManager | (Inherited from WebPart.) | |
WebPartMenu | (Inherited from WebPart.) | |
Width | (Inherited from WebPart.) | |
WorkItemTimeout | Obsolete. (Inherited from WebPart.) | |
Wrap | (Inherited from Panel.) | |
Zone | (Inherited from WebPart.) | |
ZoneID | (Inherited from WebPart.) | |
ZoneIndex | (Inherited from WebPart.) |
Top
Methods
Top
Events
Name | Description | |
---|---|---|
AfterSerializeToClient | (Inherited from ScriptWebPart.) | |
BeforeSerializeToClient | (Inherited from ScriptWebPart.) | |
DataBinding | (Inherited from Control.) | |
Disposed | (Inherited from Control.) | |
Init | (Inherited from Control.) | |
Load | (Inherited from Control.) | |
PreRender | (Inherited from Control.) | |
Unload | (Inherited from Control.) |
Top
Fields
Name | Description | |
---|---|---|
intentRow | For internal use only. | |
searchedForTemplateSelectedPropsValue | (Inherited from ResultScriptWebPart.) | |
substrateRow | For internal use only. |
Top
Explicit interface implementations
Name | Description | |
---|---|---|
IParserAccessor.AddParsedSubObject | (Inherited from Control.) | |
IControlBuilderAccessor.ControlBuilder | (Inherited from Control.) | |
IDataBindingsAccessor.DataBindings | (Inherited from Control.) | |
IExpressionsAccessor.Expressions | (Inherited from Control.) | |
IAttributeAccessor.GetAttribute | (Inherited from WebPart.) | |
IConnectionData.GetData | (Inherited from WebPart.) | |
IControlDesignerAccessor.GetDesignModeState | (Inherited from Control.) | |
IConnectionData.GetRequiresData | (Inherited from WebPart.) | |
IDataBindingsAccessor.HasDataBindings | (Inherited from Control.) | |
IExpressionsAccessor.HasExpressions | (Inherited from Control.) | |
ICompositeControlDesignerAccessor.RecreateChildControls | (Inherited from Part.) | |
IAttributeAccessor.SetAttribute | (Inherited from WebPart.) | |
IControlDesignerAccessor.SetDesignModeState | (Inherited from Control.) | |
IControlDesignerAccessor.SetOwnerControl | (Inherited from Control.) | |
IControlDesignerAccessor.UserData | (Inherited from Control.) |
Top