Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

LocationConfiguration members

Contains the configuration information for a federated search location.

The LocationConfiguration type exposes the following members.

  Name Description
Public method LocationConfiguration() Initializes a federated search location.
Public method LocationConfiguration(XmlDocument) Initializes a federated search location based on an XML federated search location definition (.osdx) file.
Top
  Name Description
Public property AdminDescription Specifies the description of the federated search location. This corresponds to the Description element of the OpenSearchDescription of the federated location definition file.
Public property AllowedSiteCollectionGuids Contains a collection of strings that specify the site GUIDs that are permitted to use this federated search location. This collection corresponds to the AllowedSiteCollectionGuids element of the OpenSearchDescription of the federated location definition file.
Public property AllowedSiteCollectionUrls Contains a collection of strings that specify the site URLs that are permitted to use this federated search location.
Public property AuthInfo A structure that contains authentication information for this federated search location.
Public property Author Contains the author of this federated search location.
Public property ConnectionUrlTemplate Specifies the query template that determines how to pass search queries to an OpenSearch location's URL. This corresponds to the ConnectionUrlTemplate element of the OpenSearchDescription of the federated location definition file.
Public property CreationDate Specifies the creation date of the federated search location. This date corresponds to the CreationDate element of the OpenSearchDescription of the federated location definition file.
Public property DescriptionXml
Public property FullVisualization Reserved for future use.
Public property InternalName Specifies a unique name to identify the federated search location. This name corresponds to the InternalName element of the OpenSearchDescription of the federated location definition file.
Public property IsDeletable Gets a value that specifies whether the location can be deleted. Only some preinstalled locations cannot be deleted. All other locations can be deleted, and this value cannot be changed.
Public property IsPrefixPattern Specifies whether the value in the QueryReformatPattern member is for a prefix match. This corresponds to the IsPrefixPattern element of the OpenSearchDescription of the federated location definition file.
Public property IsRestrictedLocation Specifies whether there are any restrictions on the sites that can use this federated search location. This corresponds to the IsRestricted element of the OpenSearchDescription of the federated location definition file.
Public property KindsOfResults Reserved for future use.
Public property Languages Represents a list of CultureInfo objects that specify the languages for the federated search location.
Public property LastModifiedDate Specifies the last date of modification by the search administration component.
Public property MoreLinkTemplate Specifies the link template that determines the federated search location URL of the HTML page that displays results for the search query. This template corresponds to the MoreLinkTemplate element of the OpenSearchDescription of the federated location definition file.
Public property Name Specifies the display name for the federated search location.
Public property ProxyUrl This member is reserved for internal use and is not intended to be used directly from your code.
Public property QueryReformatPattern Specifies a string containing a pattern that a query must match to trigger a search on the federated location.
Public property QueryRestriction Specifies a string containing a semicolon-delimited list that determines the start addresses of URL domains that can use this location.
Public property SummaryVisualization Specifies a Visualization object that determines the summary display format for the federated search location results.
Public property TopAnswerVisualization Specifies a Visualization object that determines the top-answer display format for the federated search location results.
Public property Type Specifies the type of federated search location. This corresponds to the LocationType element of the OpenSearchDescription of the federated location definition file.
Public property Version Specifies the location definition version. This corresponds to the Version element of the OpenSearchDescription of the federated location definition file.
Public property Visualizations Specifies a Dictionary object that determines the Visualization objects associated with the federated location. Each key is a string that specifies the name of the Visualization, and each value is a Visualization object.
Top
  Name Description
Public method Equals (Inherited from Object.)
Public method Export Generates the XML that contains the information for the federated location and places it into the specified stream.
Public method ExportToXml Generates an XML file that contains the information for the federated location.
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method Import Updates a federated location's configuration from XML.
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)
Public method Update Updates the federated search location configuration.
Top
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.