|  | Aqualogic Interaction API | |
| IPTSearchResponse.GetKWICFieldsAsString Method |
Returns keyword-in-context ("KWIC") information for the given result and property. This is a String containing snippets of text from the given result; search keywords from the original query are enclosed in highlight tags that specify an HTML span of style listHiliteText.
This method is usually called with PT_INTRINSICS.PT_PROPERTY_OBJECTSUMMARY, in which case it has special-case behavior to find the best KWIC information from the OBJECTSUMMARY and full-text content fields. This is how the portal generates the summaries that appear below the result title. However, you may call it with any other property used to constrain the search, and it will return KWIC info for that property if it exists.
string GetKWICFieldsAsString(
int nRank,
int nPropertyID
);
Parameters
- nRank
- Ungrouped result rank, in the range 0 to (GetReturnedResults()-1).
- nPropertyID
- PT_INTRINSICS.PT_PROPERTY_OBJECTSUMMARY or another text property ID
Return Value
keyword-in-context string with search keywords enclosed in listHiliteText span tags
See Also
IPTSearchResponse Interface | com.plumtree.server Namespace