Class CalendarRecord
Definition
- Assembly:
- Tizen.Pims.Calendar.dll
A record represents an actual record in the database.
public class CalendarRecord : IDisposable
- Inheritance
-
objectCalendarRecord
- Implements
-
System.IDisposable
Remarks
A record represents an actual record in the database, but you can also consider it a piece of information, such as an alarm, attendee, and extended. A record can be a complex set of data, containing other data. For example, a calendar record contains the alarm property, which is a reference to an alarm record. An alarm record could belong to a event record, and its alarm ID property is set to the identifier of the corresponding event. In this case, the alarm is the child record of the event, and the event is the parent record.
Constructors
View SourceCalendarRecord(string)
Creates a record.
Declaration
public CalendarRecord(string viewUri)
Parameters
Type | Name | Description |
---|---|---|
string | viewUri | The view URI. |
Remarks
A record represents an actual record in the database, but you can also consider it a piece of information, such as an alarm, attendee, and extended. A record can be a complex set of data, containing other data. For example, a calendar record contains the alarm property, which is a reference to an alarm record. An alarm record could belong to a event record, and its alarm ID property is set to the identifier of the corresponding event. In this case, the alarm is the child record of the event, and the event is the parent record.
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. |
Properties
View SourceUri
Gets the record URI.
Declaration
public string Uri { get; }
Property Value
Type | Description |
---|---|
string | The URI of the record. |
Remarks
A record represents an actual record in the database, but you can also consider it a piece of information, such as an alarm, attendee, and extended. A record can be a complex set of data, containing other data. For example, a calendar record contains the alarm property, which is a reference to an alarm record. An alarm record could belong to a event record, and its alarm ID property is set to the identifier of the corresponding event. In this case, the alarm is the child record of the event, and the event is the parent record.
Methods
View SourceAddChildRecord(uint, CalendarRecord)
Adds a child record to the parent record.
Declaration
public void AddChildRecord(uint propertyId, CalendarRecord childRecord)
Parameters
Type | Name | Description |
---|---|---|
uint | propertyId | The property ID. |
CalendarRecord | childRecord | The child record. |
Remarks
A record represents an actual record in the database, but you can also consider it a piece of information, such as an alarm, attendee, and extended. A record can be a complex set of data, containing other data. For example, a calendar record contains the alarm property, which is a reference to an alarm record. An alarm record could belong to a event record, and its alarm ID property is set to the identifier of the corresponding event. In this case, the alarm is the child record of the event, and the event is the parent record.
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. |
Clone()
Makes a clone of a record.
Declaration
public CalendarRecord Clone()
Returns
Type | Description |
---|---|
CalendarRecord | A cloned record. |
Remarks
A record represents an actual record in the database, but you can also consider it a piece of information, such as an alarm, attendee, and extended. A record can be a complex set of data, containing other data. For example, a calendar record contains the alarm property, which is a reference to an alarm record. An alarm record could belong to a event record, and its alarm ID property is set to the identifier of the corresponding event. In this case, the alarm is the child record of the event, and the event is the parent record.
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the feature is not supported. |
System.OutOfMemoryException | Thrown when failed due to out of memory. |
CloneChildRecordList(uint)
Clones a child record list corresponding to property ID.
Declaration
public CalendarList CloneChildRecordList(uint propertyId)
Parameters
Type | Name | Description |
---|---|---|
uint | propertyId | The property ID. |
Returns
Type | Description |
---|---|
CalendarList | The record list. |
Remarks
A record represents an actual record in the database, but you can also consider it a piece of information, such as an alarm, attendee, and extended. A record can be a complex set of data, containing other data. For example, a calendar record contains the alarm property, which is a reference to an alarm record. An alarm record could belong to a event record, and its alarm ID property is set to the identifier of the corresponding event. In this case, the alarm is the child record of the event, and the event is the parent record.
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 CalendarRecord. It should be called after it has finished using the object.
Declaration
public void Dispose()
Remarks
A record represents an actual record in the database, but you can also consider it a piece of information, such as an alarm, attendee, and extended. A record can be a complex set of data, containing other data. For example, a calendar record contains the alarm property, which is a reference to an alarm record. An alarm record could belong to a event record, and its alarm ID property is set to the identifier of the corresponding event. In this case, the alarm is the child record of the event, and the event is the parent record.
Dispose(bool)
Disposes of the resources (other than memory) used by the CalendarRecord.
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. |
Remarks
A record represents an actual record in the database, but you can also consider it a piece of information, such as an alarm, attendee, and extended. A record can be a complex set of data, containing other data. For example, a calendar record contains the alarm property, which is a reference to an alarm record. An alarm record could belong to a event record, and its alarm ID property is set to the identifier of the corresponding event. In this case, the alarm is the child record of the event, and the event is the parent record.
~CalendarRecord()
Destructor.
Declaration
protected ~CalendarRecord()
Remarks
A record represents an actual record in the database, but you can also consider it a piece of information, such as an alarm, attendee, and extended. A record can be a complex set of data, containing other data. For example, a calendar record contains the alarm property, which is a reference to an alarm record. An alarm record could belong to a event record, and its alarm ID property is set to the identifier of the corresponding event. In this case, the alarm is the child record of the event, and the event is the parent record.
Get<T>(uint)
Gets a object from a record.
Declaration
public T Get<T>(uint propertyId)
Parameters
Type | Name | Description |
---|---|---|
uint | propertyId | The property ID. |
Returns
Type | Description |
---|---|
T | The value of the property corresponding to property ID. |
Type Parameters
Name | Description |
---|---|
T |
Remarks
A record represents an actual record in the database, but you can also consider it a piece of information, such as an alarm, attendee, and extended. A record can be a complex set of data, containing other data. For example, a calendar record contains the alarm property, which is a reference to an alarm record. An alarm record could belong to a event record, and its alarm ID property is set to the identifier of the corresponding event. In this case, the alarm is the child record of the event, and the event is the parent record.
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. |
GetChildRecord(uint, int)
Gets a child record from the parent record.
Declaration
public CalendarRecord GetChildRecord(uint propertyId, int index)
Parameters
Type | Name | Description |
---|---|---|
uint | propertyId | The property ID. |
int | index | The child record index. |
Returns
Type | Description |
---|---|
CalendarRecord | The record. |
Remarks
A record represents an actual record in the database, but you can also consider it a piece of information, such as an alarm, attendee, and extended. A record can be a complex set of data, containing other data. For example, a calendar record contains the alarm property, which is a reference to an alarm record. An alarm record could belong to a event record, and its alarm ID property is set to the identifier of the corresponding event. In this case, the alarm is the child record of the event, and the event is the parent record.
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. |
GetChildRecordCount(uint)
Gets a child record from the parent record.
Declaration
public int GetChildRecordCount(uint propertyId)
Parameters
Type | Name | Description |
---|---|---|
uint | propertyId | The property ID. |
Returns
Type | Description |
---|---|
int | The number of child records corresponding to property ID. |
Remarks
A record represents an actual record in the database, but you can also consider it a piece of information, such as an alarm, attendee, and extended. A record can be a complex set of data, containing other data. For example, a calendar record contains the alarm property, which is a reference to an alarm record. An alarm record could belong to a event record, and its alarm ID property is set to the identifier of the corresponding event. In this case, the alarm is the child record of the event, and the event is the parent record.
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. |
RemoveChildRecord(uint, CalendarRecord)
Removes a child record from the parent record.
Declaration
public void RemoveChildRecord(uint propertyId, CalendarRecord childRecord)
Parameters
Type | Name | Description |
---|---|---|
uint | propertyId | The property ID. |
CalendarRecord | childRecord | The child record. |
Remarks
A record represents an actual record in the database, but you can also consider it a piece of information, such as an alarm, attendee, and extended. A record can be a complex set of data, containing other data. For example, a calendar record contains the alarm property, which is a reference to an alarm record. An alarm record could belong to a event record, and its alarm ID property is set to the identifier of the corresponding event. In this case, the alarm is the child record of the event, and the event is the parent record.
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. |
Set<T>(uint, T)
Sets a value of the property to a record.
Declaration
public void Set<T>(uint propertyId, T value)
Parameters
Type | Name | Description |
---|---|---|
uint | propertyId | The property ID. |
T | value | The value. |
Type Parameters
Name | Description |
---|---|
T |
Remarks
A record represents an actual record in the database, but you can also consider it a piece of information, such as an alarm, attendee, and extended. A record can be a complex set of data, containing other data. For example, a calendar record contains the alarm property, which is a reference to an alarm record. An alarm record could belong to a event record, and its alarm ID property is set to the identifier of the corresponding event. In this case, the alarm is the child record of the event, and the event is the parent record.
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. |