Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html
blob: 81edbb4385e3896f24cd133272f310eaa86434e3 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>Lucene.Net: Lucene.Net.Search.Highlight.TextFragment Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Lucene.Net
&#160;<span id="projectnumber">3.0.3</span>
</div>
<div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="Index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Packages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_search.html">Search</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_search_1_1_highlight.html">Highlight</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html">TextFragment</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.Highlight.TextFragment Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Low-level class used to record information about a section of a document with a score.
<a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4a5a0c303f836a5acaa0459301216c1f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html#a4a5a0c303f836a5acaa0459301216c1f">TextFragment</a> (StringBuilder markedUpText, int textStartPos, int fragNum)</td></tr>
<tr class="separator:a4a5a0c303f836a5acaa0459301216c1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afba21fd4dff71ada184fdb680474c2b2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html#afba21fd4dff71ada184fdb680474c2b2">Merge</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html">TextFragment</a> frag2)</td></tr>
<tr class="memdesc:afba21fd4dff71ada184fdb680474c2b2"><td class="mdescLeft">&#160;</td><td class="mdescRight"> <a href="#afba21fd4dff71ada184fdb680474c2b2"></a><br/></td></tr>
<tr class="separator:afba21fd4dff71ada184fdb680474c2b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aadf2cc7371b58e9ef03947f5d1d65788"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html#aadf2cc7371b58e9ef03947f5d1d65788">Follows</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html">TextFragment</a> fragment)</td></tr>
<tr class="memdesc:aadf2cc7371b58e9ef03947f5d1d65788"><td class="mdescLeft">&#160;</td><td class="mdescRight">true if this fragment follows the one passed <a href="#aadf2cc7371b58e9ef03947f5d1d65788"></a><br/></td></tr>
<tr class="separator:aadf2cc7371b58e9ef03947f5d1d65788"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af31e8927f244d55e27588a049ebf8c66"><td class="memItemLeft" align="right" valign="top">override String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html#af31e8927f244d55e27588a049ebf8c66">ToString</a> ()</td></tr>
<tr class="memdesc:af31e8927f244d55e27588a049ebf8c66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the marked-up text for this text fragment <a href="#af31e8927f244d55e27588a049ebf8c66"></a><br/></td></tr>
<tr class="separator:af31e8927f244d55e27588a049ebf8c66"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a8ade902d892bad5ff7a30465bc9e440f"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html#a8ade902d892bad5ff7a30465bc9e440f">Score</a><code> [get, set]</code></td></tr>
<tr class="separator:a8ade902d892bad5ff7a30465bc9e440f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61d148f3189e51fa75a6e6744dbf3ae7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html#a61d148f3189e51fa75a6e6744dbf3ae7">TextEndPos</a><code> [get, set]</code></td></tr>
<tr class="separator:a61d148f3189e51fa75a6e6744dbf3ae7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6414569bd7dce790811c0e360a8757ca"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html#a6414569bd7dce790811c0e360a8757ca">TextStartPos</a><code> [get, set]</code></td></tr>
<tr class="separator:a6414569bd7dce790811c0e360a8757ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf3b2a44ce1ecdb56d5dd05ca314c606"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html#aaf3b2a44ce1ecdb56d5dd05ca314c606">FragNum</a><code> [get, set]</code></td></tr>
<tr class="memdesc:aaf3b2a44ce1ecdb56d5dd05ca314c606"><td class="mdescLeft">&#160;</td><td class="mdescRight">the fragment sequence number <a href="#aaf3b2a44ce1ecdb56d5dd05ca314c606"></a><br/></td></tr>
<tr class="separator:aaf3b2a44ce1ecdb56d5dd05ca314c606"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Low-level class used to record information about a section of a document with a score. </p>
<p>Definition at line <a class="el" href="_text_fragment_8cs_source.html#l00026">26</a> of file <a class="el" href="_text_fragment_8cs_source.html">TextFragment.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4a5a0c303f836a5acaa0459301216c1f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.TextFragment.TextFragment </td>
<td>(</td>
<td class="paramtype">StringBuilder&#160;</td>
<td class="paramname"><em>markedUpText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>textStartPos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>fragNum</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_text_fragment_8cs_source.html#l00031">31</a> of file <a class="el" href="_text_fragment_8cs_source.html">TextFragment.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aadf2cc7371b58e9ef03947f5d1d65788"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Lucene.Net.Search.Highlight.TextFragment.Follows </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html">TextFragment</a>&#160;</td>
<td class="paramname"><em>fragment</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>true if this fragment follows the one passed </p>
<p>Definition at line <a class="el" href="_text_fragment_8cs_source.html#l00059">59</a> of file <a class="el" href="_text_fragment_8cs_source.html">TextFragment.cs</a>.</p>
</div>
</div>
<a class="anchor" id="afba21fd4dff71ada184fdb680474c2b2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Search.Highlight.TextFragment.Merge </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html">TextFragment</a>&#160;</td>
<td class="paramname"><em>frag2</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">frag2</td><td>Fragment to be merged into this one</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_text_fragment_8cs_source.html#l00050">50</a> of file <a class="el" href="_text_fragment_8cs_source.html">TextFragment.cs</a>.</p>
</div>
</div>
<a class="anchor" id="af31e8927f244d55e27588a049ebf8c66"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override String Lucene.Net.Search.Highlight.TextFragment.ToString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the marked-up text for this text fragment </p>
<p>Definition at line <a class="el" href="_text_fragment_8cs_source.html#l00067">67</a> of file <a class="el" href="_text_fragment_8cs_source.html">TextFragment.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="aaf3b2a44ce1ecdb56d5dd05ca314c606"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Search.Highlight.TextFragment.FragNum</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>the fragment sequence number </p>
<p>Definition at line <a class="el" href="_text_fragment_8cs_source.html#l00045">45</a> of file <a class="el" href="_text_fragment_8cs_source.html">TextFragment.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a8ade902d892bad5ff7a30465bc9e440f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float Lucene.Net.Search.Highlight.TextFragment.Score</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_text_fragment_8cs_source.html#l00038">38</a> of file <a class="el" href="_text_fragment_8cs_source.html">TextFragment.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a61d148f3189e51fa75a6e6744dbf3ae7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Search.Highlight.TextFragment.TextEndPos</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_text_fragment_8cs_source.html#l00039">39</a> of file <a class="el" href="_text_fragment_8cs_source.html">TextFragment.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a6414569bd7dce790811c0e360a8757ca"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Search.Highlight.TextFragment.TextStartPos</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_text_fragment_8cs_source.html#l00040">40</a> of file <a class="el" href="_text_fragment_8cs_source.html">TextFragment.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/Highlighter/<a class="el" href="_text_fragment_8cs_source.html">TextFragment.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:58 for Lucene.Net by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>