XSLT Extensions: Search

Activation

Enabling the XSLT extension for use in your XSLT templates. Add the following XML snippet to your ~/config/xsltExtensions.config file:

<XsltExtensions>
	...
	<ext assembly="uComponents.XsltExtensions" type="uComponents.XsltExtensions.Search" alias="ucomponents.search" />
	...
</XsltExtensions>

Methods

Here are available methods in the Search library:

• AdvancedSearch
• AdvancedSearch
• AdvancedSearch
• AdvancedSearch
• GetNodeIds
• GetNodeIds
• GetNodeIds
• QuickSearch
• QuickSearch
• QuickSearch
• RawQuery
• InternalSearch
• GetResultsAsXml

AdvancedSearch

Performs an advanced search against an Examine/Lucene index. Returns: Returns an XML structure of the advanced search results.

Parameters

| Name | Type | Notes | |——|——|——-| | searchText | System.String | |

XSLT Example

<xsl:value-of select="ucomponents.search:AdvancedSearch(searchText)" />

AdvancedSearch

Performs an advanced search against an Examine/Lucene index. Returns: Returns an XML structure of the advanced search results.

Parameters

| Name | Type | Notes | |——|——|——-| | searchText | System.String | | | useWildcards | System.Boolean | |

XSLT Example

<xsl:value-of select="ucomponents.search:AdvancedSearch(searchText, useWildcards)" />

AdvancedSearch

Advanceds the search. Returns: Returns an XML structure of the advanced search results.

Parameters

| Name | Type | Notes | |——|——|——-| | searchText | System.String | | | useWildcards | System.Boolean | | | providerName | System.String | |

XSLT Example

<xsl:value-of select="ucomponents.search:AdvancedSearch(searchText, useWildcards, providerName)" />

AdvancedSearch

Performs an advanced search against an Examine/Lucene index. Returns: Returns an XML structure of the advanced search results.

Parameters

| Name | Type | Notes | |——|——|——-| | searchText | System.String | | | useWildcards | System.Boolean | | | providerName | System.String | | | indexType | System.String | |

XSLT Example

<xsl:value-of select="ucomponents.search:AdvancedSearch(searchText, useWildcards, providerName, indexType)" />

GetNodeIds

Gets the node ids. Returns: Returns a CSV of node Ids from a basic/quick search

Parameters

| Name | Type | Notes | |——|——|——-| | searchText | System.String | |

XSLT Example

<xsl:value-of select="ucomponents.search:GetNodeIds(searchText)" />

GetNodeIds

Gets the node ids. Returns: Returns a CSV of node Ids from a basic/quick search

Parameters

| Name | Type | Notes | |——|——|——-| | searchText | System.String | | | useWildcards | System.Boolean | |

XSLT Example

<xsl:value-of select="ucomponents.search:GetNodeIds(searchText, useWildcards)" />

GetNodeIds

Gets the node ids. Returns: Returns a CSV of node Ids from a basic/quick search

Parameters

| Name | Type | Notes | |——|——|——-| | searchText | System.String | | | useWildcards | System.Boolean | | | providerName | System.String | |

XSLT Example

<xsl:value-of select="ucomponents.search:GetNodeIds(searchText, useWildcards, providerName)" />

QuickSearch

Performs a basic/quick search against an Examine/Lucene index. Returns: Returns an XML structure of the basic/quick search results.

Parameters

| Name | Type | Notes | |——|——|——-| | searchText | System.String | |

XSLT Example

<xsl:value-of select="ucomponents.search:QuickSearch(searchText)" />

QuickSearch

Performs a basic/quick search against an Examine/Lucene index. Returns: Returns an XML structure of the basic/quick search results.

Parameters

| Name | Type | Notes | |——|——|——-| | searchText | System.String | | | useWildcards | System.Boolean | |

XSLT Example

<xsl:value-of select="ucomponents.search:QuickSearch(searchText, useWildcards)" />

QuickSearch

Performs a basic/quick search against an Examine/Lucene index. Returns: Returns an XML structure of the basic/quick search results.

Parameters

| Name | Type | Notes | |——|——|——-| | searchText | System.String | | | useWildcards | System.Boolean | | | providerName | System.String | |

XSLT Example

<xsl:value-of select="ucomponents.search:QuickSearch(searchText, useWildcards, providerName)" />

RawQuery

Performs a raw query against the specified Examine/Lucene provider. Returns: Returns an XML structure of the raw search query results.

Parameters

| Name | Type | Notes | |——|——|——-| | rawQuery | System.String | | | useWildcards | System.Boolean | | | providerName | System.String | | | indexType | System.String | |

XSLT Example

<xsl:value-of select="ucomponents.search:RawQuery(rawQuery, useWildcards, providerName, indexType)" />

InternalSearch

Perform a search (interally).

Parameters

| Name | Type | Notes | |——|——|——-| | searchText | System.String | | | useWildcards | System.Boolean | | | providerName | System.String | |

XSLT Example

<xsl:value-of select="ucomponents.search:InternalSearch(searchText, useWildcards, providerName)" />

GetResultsAsXml

Gets the results as XML. Returns: Returns an XML structure of the search results.

Parameters

| Name | Type | Notes | |——|——|——-| | results | Examine.ISearchResults | |

XSLT Example

<xsl:value-of select="ucomponents.search:GetResultsAsXml(results)" />