diff -r 4d198a32ac7d -r d4809db37847 plugins/org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-36434377-FA7E-45F2-AEB3-BA0B7A378422.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/plugins/org.symbian.tools.wrttools.doc.WebDeveloper/html/GUID-36434377-FA7E-45F2-AEB3-BA0B7A378422.html Thu Aug 19 17:48:04 2010 -0700 @@ -0,0 +1,156 @@ + + +Criteria for +exporting calendar entries

Criteria for +exporting calendar entries

+

The criteria object specifies the entries +to export and optionally the source calendar.

+

The criteria object has two main properties: Type and Data. +These are described in the following table. Properties enclosed in brackets +are optional.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table: Criteria object properties
+

Property

+
+

Description

+
+

Type

+
+

Value

+
+

criteria.Type

+
+

Specifies the type of calendar information to export. This is always "CalendarEntry".

+
+

string

+
+

Possible values:

+
    +
  • "CalendarEntry"

  • +
+
+

criteria.Data

+
+

Specifies the entries to export.

+
+

object

+
+

Object with the properties specified below

+
+

[criteria.Data.CalendarName]

+
+

Specifies the calendar from which the entries are exported.

+

If this property is not specified, the entries are exported from the +default calendar.

+
+

string

+
+

<DriveLetter>:<FileName>

+

For example: "C:Calendar"

+
+

[criteria.Data.IdList]

+
+

Specifies the ids of the entries to export. If +an entry has child entries, the parent entry and all child entries are exported. +Invalid values are ignored.

+

Specify either Data.IdList or Data.LocalIdList or +neither, but not both. If neither is specified, all entries in the calendar +are exported.

+

The first id is specified in Data.IdList[0].

+
+

array of strings

+
 
+

[criteria.Data.LocalIdList]

+
+

Specifies the LocalIds of the entries to export. +In case of parent and child entries, only the specific entry matching the LocalId is +exported. Invalid values are ignored.

+

Specify either Data.IdList or Data.LocalIdList or +neither, but not both. If neither is specified, all entries in the calendar +are exported.

+

The first LocalId is specified in Data.LocalIdList[0].

+
+

array of strings

+
 
+

[criteria.Data.FileName]

+
+

Specifies the full path and file name of the target file to which the +entries are exported.

+

If this property is not specified, the entries are stored in the ReturnValue property +of the result object.

+
+

string

+
+

The string cannot exceed 239 characters

+

For example: C:\\Data\\exportfile.txt

+
+

criteria.Data.Format

+
+

Specifies the data format in which the entries are exported. The supported +formats are:

+
    +
  • iCal

  • +
  • vCal

  • +
+

For more information about these two formats, see the Calendar +Service overview page.

+
+

string

+
+

Possible values:

+
    +
  • "ICal"

  • +
  • "VCal"

  • +
+
\ No newline at end of file