SearchResultSet Class
Stores the results of a find operation.
public class SearchResultSet : ISearchResultSet
- Inheritance:
- object object
- Implements:
- ISearchResultSet
Constructors
SearchResultSet(SearchOperationType, ISearchOptions, bool)
Initializes a new instance of the SearchResultSet
class.
public SearchResultSet(SearchOperationType operationType, ISearchOptions options, bool wrapped)
Parameter | Type | Description |
---|---|---|
operationType | SearchOperationType | A SearchOperationType that indicates the search operation type that was performed. |
options | ISearchOptions | A copy of the ISearchOptions that were used to generate this result set. |
wrapped | bool | Whether the find operation wrapped when it reached the end of the search text range. |
Properties
OperationType
Gets or sets a SearchOperationType that indicates the search operation type that was performed.
public SearchOperationType OperationType { get; set; }
Property Value
- SearchOperationType:
A SearchOperationType that indicates the search operation type that was performed.
Options
Gets or sets a copy of the ISearchOptions that were used to generate this result set.
public ISearchOptions Options { get; set; }
Property Value
- ISearchOptions:
A copy of the ISearchOptions that were used to generate this result set.
Results
Gets the collection of ISearchResult objects.
public ISearchResultCollection Results { get; }
Property Value
- ISearchResultCollection:
The collection of ISearchResult objects.
Wrapped
Gets or sets whether the find operation wrapped when it reached the end of the search text range.
public bool Wrapped { get; set; }
Property Value
- bool:
true
if the find operation wrapped; otherwise,false
.
Methods
ToString()
Returns a String
that represents the current Object
.