Class CalendarFilter
Definition
- Assembly:
- Tizen.Pims.Calendar.dll
A filter includes the conditions for the search.
public class CalendarFilter : IDisposable
- Inheritance
-
objectCalendarFilter
- Implements
-
System.IDisposable
Constructors
View SourceCalendarFilter(string, uint, IntegerMatchType, double)
Creates a filter with a condition for a double type.
Declaration
public CalendarFilter(string viewUri, uint propertyId, CalendarFilter.IntegerMatchType matchType, double matchValue)
Parameters
Type | Name | Description |
---|---|---|
string | viewUri | The view URI of a filter. |
uint | propertyId | The property ID to add a condition. |
CalendarFilter.IntegerMatchType | matchType | The match flag. |
double | matchValue | The match value. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when one of the arguments provided to a method is not valid. |
System.OutOfMemoryException | Thrown when failed due to out of memory. |
CalendarFilter(string, uint, IntegerMatchType, int)
Creates a filter with a condition for an integer type.
Declaration
public CalendarFilter(string viewUri, uint propertyId, CalendarFilter.IntegerMatchType matchType, int matchValue)
Parameters
Type | Name | Description |
---|---|---|
string | viewUri | The view URI of a filter. |
uint | propertyId | The property ID to add a condition. |
CalendarFilter.IntegerMatchType | matchType | The match flag. |
int | matchValue | The match value. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when one of the arguments provided to a method is not valid. |
System.OutOfMemoryException | Thrown when failed due to out of memory. |
CalendarFilter(string, uint, IntegerMatchType, long)
Creates a filter with a condition for a long type.
Declaration
public CalendarFilter(string viewUri, uint propertyId, CalendarFilter.IntegerMatchType matchType, long matchValue)
Parameters
Type | Name | Description |
---|---|---|
string | viewUri | The view URI of a filter. |
uint | propertyId | The property ID to add a condition. |
CalendarFilter.IntegerMatchType | matchType | The match flag. |
long | matchValue | The match value. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when one of the arguments provided to a method is not valid. |
System.OutOfMemoryException | Thrown when failed due to out of memory. |
CalendarFilter(string, uint, IntegerMatchType, CalendarTime)
Creates a filter with a condition for the CalendarTime type.
Declaration
public CalendarFilter(string viewUri, uint propertyId, CalendarFilter.IntegerMatchType matchType, CalendarTime matchValue)
Parameters
Type | Name | Description |
---|---|---|
string | viewUri | The view URI of a filter. |
uint | propertyId | The property ID to add a condition. |
CalendarFilter.IntegerMatchType | matchType | The match flag. |
CalendarTime | matchValue | The match value. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when one of the arguments provided to a method is not valid. |
System.OutOfMemoryException | Thrown when failed due to out of memory. |
CalendarFilter(string, uint, StringMatchType, string)
Creates a filter with a condition for a string type.
Declaration
public CalendarFilter(string viewUri, uint propertyId, CalendarFilter.StringMatchType matchType, string matchValue)
Parameters
Type | Name | Description |
---|---|---|
string | viewUri | The view URI of a filter. |
uint | propertyId | The property ID to add a condition. |
CalendarFilter.StringMatchType | matchType | The match flag. |
string | matchValue | The match value. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when one of the arguments provided to a method is not valid. |
System.OutOfMemoryException | Thrown when failed due to out of memory. |
Methods
View SourceAddCondition(LogicalOperator, uint, IntegerMatchType, double)
Adds a condition for the double type.
Declaration
public void AddCondition(CalendarFilter.LogicalOperator logicalOperator, uint propertyId, CalendarFilter.IntegerMatchType matchType, double matchValue)
Parameters
Type | Name | Description |
---|---|---|
CalendarFilter.LogicalOperator | logicalOperator | The operator type. |
uint | propertyId | The property ID to add a condition. |
CalendarFilter.IntegerMatchType | matchType | The match flag. |
double | matchValue | The match value. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when one of the arguments provided to a method is not valid. |
AddCondition(LogicalOperator, uint, IntegerMatchType, int)
Adds a condition for the integer type.
Declaration
public void AddCondition(CalendarFilter.LogicalOperator logicalOperator, uint propertyId, CalendarFilter.IntegerMatchType matchType, int matchValue)
Parameters
Type | Name | Description |
---|---|---|
CalendarFilter.LogicalOperator | logicalOperator | The operator type. |
uint | propertyId | The property ID to add a condition. |
CalendarFilter.IntegerMatchType | matchType | The match flag. |
int | matchValue | The match value. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when one of the arguments provided to a method is not valid. |
AddCondition(LogicalOperator, uint, IntegerMatchType, long)
Adds a condition for the long type.
Declaration
public void AddCondition(CalendarFilter.LogicalOperator logicalOperator, uint propertyId, CalendarFilter.IntegerMatchType matchType, long matchValue)
Parameters
Type | Name | Description |
---|---|---|
CalendarFilter.LogicalOperator | logicalOperator | The operator type. |
uint | propertyId | The property ID to add a condition. |
CalendarFilter.IntegerMatchType | matchType | The match flag. |
long | matchValue | The match value. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when one of the arguments provided to a method is not valid. |
AddCondition(LogicalOperator, uint, IntegerMatchType, CalendarTime)
Adds a condition for the CalendarTime type.
Declaration
public void AddCondition(CalendarFilter.LogicalOperator logicalOperator, uint propertyId, CalendarFilter.IntegerMatchType matchType, CalendarTime matchValue)
Parameters
Type | Name | Description |
---|---|---|
CalendarFilter.LogicalOperator | logicalOperator | The operator type. |
uint | propertyId | The property ID to add a condition. |
CalendarFilter.IntegerMatchType | matchType | The match flag. |
CalendarTime | matchValue | The match value. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when one of the arguments provided to a method is not valid. |
AddCondition(LogicalOperator, uint, StringMatchType, string)
Adds a condition for the string type.
Declaration
public void AddCondition(CalendarFilter.LogicalOperator logicalOperator, uint propertyId, CalendarFilter.StringMatchType matchType, string matchValue)
Parameters
Type | Name | Description |
---|---|---|
CalendarFilter.LogicalOperator | logicalOperator | The operator type. |
uint | propertyId | The property ID to add a condition. |
CalendarFilter.StringMatchType | matchType | The match flag. |
string | matchValue | The match value. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when one of the arguments provided to a method is not valid. |
AddFilter(LogicalOperator, CalendarFilter)
Adds a child filter to a parent filter.
Declaration
public void AddFilter(CalendarFilter.LogicalOperator logicalOperator, CalendarFilter filter)
Parameters
Type | Name | Description |
---|---|---|
CalendarFilter.LogicalOperator | logicalOperator | The operator type. |
CalendarFilter | filter | The child filter. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.ArgumentException | Thrown when one of the arguments provided to a method is not valid. |
Dispose()
Releases all the resources used by the CalendarFilter. It should be called after having finished using the object.
Declaration
public void Dispose()
Dispose(bool)
Dispose.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
bool | disposing | true to release both managed and unmanaged resources, false to release only unmanaged resources. |
~CalendarFilter()
Destroys the filter.
Declaration
protected ~CalendarFilter()