Class CalendarQuery
Definition
- Namespace:
- Tizen.Pims.Calendar
- Assembly:
- Tizen.Pims.Calendar.dll
- API Level:
- 4
A query is used to retrieve the data, which satisfies the given criteria.
public class CalendarQuery : IDisposable
- Inheritance
-
CalendarQuery
- Implements
Remarks
A query is used to retrieve the calendar data, which satisfies a given criteria, such as an integer property being greater than a given value, or a string property containing a given substring. A query needs a filter, which can set the conditions for the search.
Constructors
View SourceCalendarQuery(String)
Creates a query.
Declaration
public CalendarQuery(string viewUri)
Parameters
Type | Name | Description |
---|---|---|
String | viewUri | The view URI of a query. |
Exceptions
Type | Condition |
---|---|
NotSupportedException | Thrown when the feature is not supported. |
ArgumentException | Thrown when one of the arguments provided to a method is not valid. |
OutOfMemoryException | Thrown when failed due to out of memory. |
API Level: 4
Feature: http://tizen.org/feature/calendar
Methods
View SourceDispose()
Releases all the resources used by the CalendarQuery. It should be called after it has finished using the object.
Declaration
public void Dispose()
API Level: 4
View SourceDispose(Boolean)
Disposes of the resources (other than memory) used by the CalendarQuery.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
Boolean | disposing | true to release both managed and unmanaged resources, false to release only unmanaged resources. |
API Level: 4
View SourceFinalize()
Destructor.
Declaration
protected void Finalize()
SetDistinct(Boolean)
Sets the "distinct" option for projection.
Declaration
public void SetDistinct(bool set)
Parameters
Type | Name | Description |
---|---|---|
Boolean | set | If true it is set, otherwise if false it is unset. |
Exceptions
Type | Condition |
---|---|
NotSupportedException | Thrown when the feature is not supported. |
API Level: 4
Feature: http://tizen.org/feature/calendar
View SourceSetFilter(CalendarFilter)
Sets the filter for a query.
Declaration
public void SetFilter(CalendarFilter filter)
Parameters
Type | Name | Description |
---|---|---|
CalendarFilter | filter | The filter. |
Exceptions
Type | Condition |
---|---|
NotSupportedException | Thrown when the feature is not supported. |
ArgumentException | Thrown when one of the arguments provided to a method is not valid. |
API Level: 4
Feature: http://tizen.org/feature/calendar
View SourceSetProjection(UInt32[])
Adds the property IDs for projection.
Declaration
public void SetProjection(uint[] propertyIdArray)
Parameters
Type | Name | Description |
---|---|---|
UInt32[] | propertyIdArray | The property ID array. |
Exceptions
Type | Condition |
---|---|
NotSupportedException | Thrown when the feature is not supported. |
ArgumentException | Thrown when one of the arguments provided to a method is not valid. |
API Level: 4
Feature: http://tizen.org/feature/calendar
View SourceSetSort(UInt32, Boolean)
Sets the sort mode for a query.
Declaration
public void SetSort(uint propertyId, bool isAscending)
Parameters
Type | Name | Description |
---|---|---|
UInt32 | propertyId | The property ID to sort. |
Boolean | isAscending | If true it sorts in the ascending order, otherwise if false it sorts in the descending order. |
Exceptions
Type | Condition |
---|---|
NotSupportedException | Thrown when the feature is not supported. |
ArgumentException | Thrown when one of the arguments provided to a method is not valid. |