ComponentOne Web API Edition
GetInstanceSearchResults Method

C1.Web.Api.Report Namespace > ReportController Class : GetInstanceSearchResults Method
The full path of the report.
The report instance id.
The text used to be searched.
A boolean value indicates if search the value with case sensitive.
A boolean value indicates if search the value with matching a whole word.
0-based index of the first page to search.
The search scope.
Gets the search result in the report instance with specified instance id.
Syntax
'Declaration
 
<PathRouteAttribute(Template="{*reportPath}$instances/{instanceId}/search", 
   Name="", 
   ExcludingKeywords=, 
   Order=0)>
<HttpGetAttribute()>
Public Overridable Function GetInstanceSearchResults( _
   ByVal reportPath As String, _
   ByVal instanceId As String, _
   ByVal text As String, _
   Optional ByVal matchCase As Boolean, _
   Optional ByVal wholeWord As Boolean, _
   Optional ByVal startPageIndex As Integer, _
   Optional ByVal scope As SearchScope _
) As IHttpActionResult
[PathRoute(Template="{*reportPath}$instances/{instanceId}/search", 
   Name="", 
   ExcludingKeywords=, 
   Order=0)]
[HttpGet()]
public virtual IHttpActionResult GetInstanceSearchResults( 
   string reportPath,
   string instanceId,
   string text,
   bool matchCase,
   bool wholeWord,
   int startPageIndex,
   SearchScope scope
)

Parameters

reportPath
The full path of the report.
instanceId
The report instance id.
text
The text used to be searched.
matchCase
A boolean value indicates if search the value with case sensitive.
wholeWord
A boolean value indicates if search the value with matching a whole word.
startPageIndex
0-based index of the first page to search.
scope
The search scope.

Return Value

An System.Web.Http.IHttpActionResult type object with content of collection of C1.Web.Api.Document.Models.SearchResult type object.
Remarks
Please ensure the report instance is rendered.
See Also

Reference

ReportController Class
ReportController Members