LocationConfiguration Members
Include Protected Members
Include Inherited Members
Contains the configuration information for a federated search location.
The LocationConfiguration type exposes the following members.
Constructors
Name | Description | |
---|---|---|
LocationConfiguration() | Initializes a federated search location. | |
LocationConfiguration(XmlDocument) | Initializes a federated search location based on an XML federated search location definition (.osdx) file. |
Top
Properties
Name | Description | |
---|---|---|
AdminDescription | Specifies the description of the federated search location. This corresponds to the Description element of the OpenSearchDescription Element (Location Definition) of the federated location definition file. | |
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 Element (Location Definition) of the federated location definition file. | |
AllowedSiteCollectionUrls | Contains a collection of strings that specify the site URLs that are permitted to use this federated search location. | |
AuthInfo | A structure that contains authentication information for this federated search location. | |
Author | Contains the author of this federated search location. | |
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 Element (Location Definition) of the federated location definition file. | |
CreationDate | Specifies the creation date of the federated search location. This date corresponds to the CreationDate element of the OpenSearchDescription Element (Location Definition) of the federated location definition file. | |
DescriptionXml | ||
FullVisualization | Reserved for future use. | |
InternalName | Specifies a unique name to identify the federated search location. This name corresponds to the InternalName element of the OpenSearchDescription Element (Location Definition) of the federated location definition file. | |
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. | |
IsPrefixPattern | Specifies whether the value in the QueryReformatPattern member is for a prefix match. This corresponds to the IsPrefixPattern element of the OpenSearchDescription Element (Location Definition) of the federated location definition file. | |
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 Element (Location Definition) of the federated location definition file. | |
KindsOfResults | Reserved for future use. | |
Languages | Represents a list of CultureInfo objects that specify the languages for the federated search location. | |
LastModifiedDate | Specifies the last date of modification by the search administration component. | |
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 Element (Location Definition) of the federated location definition file. | |
Name | Specifies the display name for the federated search location. | |
ProxyUrl | This member is reserved for internal use and is not intended to be used directly from your code. | |
QueryReformatPattern | Specifies a string containing a pattern that a query must match to trigger a search on the federated location. | |
QueryRestriction | Specifies a string containing a semicolon-delimited list that determines the start addresses of URL domains that can use this location. | |
SummaryVisualization | Specifies a Visualization object that determines the summary display format for the federated search location results. | |
TopAnswerVisualization | Specifies a Visualization object that determines the top-answer display format for the federated search location results. | |
Type | Specifies the type of federated search location. This corresponds to the LocationType element of the OpenSearchDescription Element (Location Definition) of the federated location definition file. | |
Version | Specifies the location definition version. This corresponds to the Version element of the OpenSearchDescription Element (Location Definition) of the federated location definition file. | |
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
Methods
Name | Description | |
---|---|---|
Equals | (Inherited from Object.) | |
Export | Generates the XML that contains the information for the federated location and places it into the specified stream. | |
ExportToXml | Generates an XML file that contains the information for the federated location. | |
Finalize | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
Import | Updates a federated location's configuration from XML. | |
MemberwiseClone | (Inherited from Object.) | |
ToString | (Inherited from Object.) | |
Update | Updates the federated search location configuration. |
Top