SharePoint Integrator V4 - Online Help
SharePoint Integrator V4
Questions / Feedback?

SPSearch Component

Properties   Methods   Events   Configuration Settings   Errors  

Provides search capabilities to a SharePoint site.

Syntax

nsoftware.InSP.Spsearch

Remarks

The SPSearch component allows you to search SharePoint sites.

To get started, set the URL, User, and Password properties to point the component to your Site.

To retrieve the status for the search service on the SharePoint site, call the GetStatus method.

To use the search service, set the SearchType property to the type of query to use in the search. Next, call the Search method with a valid Query parameter. Once the method returns, the ResultCount and ResultIndex properties can be used to iterate through each search result. The ResultProperties collection can be used to get information about each of the results returned by SharePoint.

About SharePoint Online Services

When using Microsoft SharePoint Online you must set AuthScheme to authSPOnline (7).

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

AuthSchemeThe authentication scheme to be used while authenticating with the server.
EnableStemmingEnables stemming in the search.
FirewallA set of properties related to firewall access.
IdleThe current status of the component.
IgnoreNoiseWhether or not to ignore noise words in the search.
PasswordThe password to use for authentication.
PropertiesA list of properties to return in the results.
ProxyA set of properties related to proxy access.
RangeCountThe number of results to return in the search.
RangeStartThe starting index of the results.
ResultCountThe number of results.
ResultIndexThe result index.
ResultPropertiesA collection of result properties.
SearchTypeThe type of query used in the search.
SharePointVersionThe SharePoint version.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TimeoutA timeout for the component.
TotalResultsGets the total number of results. This property is populated after calling to Search .
TrimDuplicatesRemove duplicate results.
URLThe base URL for the site.
UserThe user account to use for authentication.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting .
DoEventsProcesses events from the internal message queue.
GetResultPropertyRetrieves the value of a property of a result.
GetStatusGet the status of the search service.
InterruptInterrupt the current method.
ResetResets request-related properties.
SearchSearches the specified SharePoint site.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

CapitalizeFirstLettersWhether or not to capitalize the first letter.
EnableSpellCheckEnables spell checking.
HighlightQuerySuggestionsWhether or not to highlight query suggestions.
IncludeHighConfidenceResultsIncludes high-confidence results.
IncludeImplicitANDWhether to include a default AND between search terms.
IncludePreQuerySuggestionsIncludes pre-query suggestions.
IncludeRelevantResultsIncludes relevant results.
IncludeSpecialTermResultsIncludes special term results.
ResubmitFlagsSpecifies how to handle resubmissions.
ResultProviderThe result provider to use.
ResultTypeThe result type of the current search result.
ElapsedTimeThe total time (in milliseconds) used for the search.
IsTotalResultsExactDetermines if the TotalResults is exact.
FormBasedCookiesHolds the security cookies for Form-Based Authentication.
SPOnlineSecurityCookiesHolds the security cookies for SharePoint Online.
SPOnlineSSOWhether to use Single Sign On (SSO) with Active Directory Federation Services (ADFS).
SPOnlineSTSThe URL of the online STS.
SPOnlineADFSAuthSchemeThe HTTP authentication scheme used when working with SSO.
SSODomainSpecifies the federation domain configured in Office 365.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 4.0.6240.0