Tasks Plugin - Technical Informations
Description: Displays all the tasks on the user's schedule.
Installation: Simply run OxiosPluginsSetup.exe and install a compatible Home Screen.
Alternatively, you can copy the OxiosPlugins.ARM.CAB file to your phone and execute it yourself.
With OxiosReplaceAllDayEvent.CAB you can overwrite the "MS AllDayEvent Plug-In" with "Oxios Tasks Plug-In", so you will see your tasks with all standard Home Screens.
Class ID: {0FD763F8-2BBE-42A1-94A8-A75A3758049E}
Text wraps if necessary: Yes.
Receives selection: Yes. Action launches "Oxios ToDo List" or the built-in Tasks program. Navigation pad (left and right) change the displayed task.
Hide on phone lock: No.
Configuration: Yes. Registry on the phone (use a Smartphone Registry Editor like PHM Registry Editor).
You should restart the phone or switch the homescreen after a registry modification.
Default Key : HKCU\Software\Oxios Plugins\Tasks
| Keys |
Signification |
Examples (*Default value) |
| Restrict |
A restriction string that defines which items to include in the collection.
This must contain a boolean expression that evaluates to TRUE or FALSE for any item.
Enclose property names between brackets.
You can combine with AND and OR.
Comparison operators are the following: <, <=, >, >=, = or <>.
For example, the restriction string [Complete] = 1 returns only the completed tasks. |
[Complete] = 0
or
[Importance] = 2 AND [Complete] = 0
or
([StartDate] = "%1" OR [DueDate] <= "%1") AND [Complete] = 0
or
([StartDate] = "%1" OR [DueDate] = "%1") AND [Complete] = 0
or
[DueDate] = "%1" AND [Complete] = 0
or
[TeamTask] = 1
...
|
| SortProperty |
The property on which to sort. |
[Subject]
or
[StartDate]
or
[DueDate]
...
|
| SortOrder |
Set to 1 to sort in descending order or 0 to sort in ascending order. |
0
1 |
| NoEndScroll |
Set to 1 to cycle after the last task. |
0
1 |
Remarks
Restrict value must be formatted properly.
String values must be enclosed between quotes. For example, [Subject] = "Oxios".
Int/long/enum values must not be enclosed between quotes. For example, [Importance] = 1.
Date/time values must be in 24 hr format. For example, [StartDate] > "05/10/2005 20:30".
This plugin use IPOutlookItemCollection::Find from Microsoft.
| Properties in Restrict and SortProperty |
Comments |
Warning: [ReminderTime] does'nt exist |
[Subject] |
Subject |
[Body] |
Notes |
[ReminderSet] |
0 False
1 True |
[Sensitivity] |
0 Normal
1 Personal
2 Private
3 Confidential |
[IsRecurring] |
0 False
1 True |
[Importance] |
0 Low
1 Normal
2 High |
[Complete] |
0 False
1 True |
[TeamTask] |
0 False
1 True |
[StartDate] |
"%1" Today
"%2" None... |
[DueDate] |
"%1" Today
"%2" None... |
[DateCompleted] |
"%1" Today
"%2" None... |
|
Variables for [StartDate] or [DueDate] |
Signification |
"%1" |
Today |
"%2" |
None |
"%3" |
Today - 1 day |
"%4" |
Today + 1 day |
"%5" |
Today - 3 days |
"%6" |
Today + 3 days |
"%7" |
Today - 7 days |
"%8" |
Today + 7 days |
|
Multi-plugins: Yes, you can have multiple plugins on your homescreen with different criteria per plugin.
So, suppose you want one line on your homescreen for tasks due today and another for overdue tasks and another for tasks due tomorrow or any other combination you desire, you just use the plugin multiple times in your XML.
If you use more than one, the regkey attribute in the <plugin> element is used to change the Registry key.
<plugin clsid="{0FD763F8-2BBE-42A1-94A8-A75A3758049E}" height="18" regkey="MyTaskReg">
...
</plugin>
The Registry key becomes HKCU\Software\Oxios Plugins\MyTaskReg
Tags in .home.xml file:
The only supported variable is the <subject/> element, which displays the subject of the task.
In addition to the <label/> element, a <format/> tag can be specified at the top level of the plug-in to indicate that the entire plug-in should hide when there is no task for the current restriction. The XML for this behavior is as follows.
<format state="noevent" visible="false"/>
If this tag is omitted, the plug-in is shown when no task exist for the current restriction.
To control the background of the plug-in, use the <background/> tag.
A priority icon can be positioned by using the <priority/> tag.
The task priority icon is shown at the location specified by a <priority x="-12" y="3"/> tag using the x and y attributes. Aside from the x and y attributes, all other attributes are ignored in the <priority/> tag for the priority icon.
The x-axis could be negativ New! to change the horizontal alignment of the image within the plug-in's drawable region.
This option is very usefull for home screen compatible Portrait/Landscape.
Sample for .home.xml file:
<plugin clsid="{0FD763F8-2BBE-42A1-94A8-A75A3758049E}" name="OxiosTasks" height="25">
<background>
<format state="selected" bgcolor="COLOR_HOMEHIGHLIGHT"/>
</background>
<format state="noevent" visible="false"/>
<label h="22" padding-right="14">
<text><subject/></text>
</label>
<priority x="-12" y="3"/>
</plugin>
|
