The programming interface syntax for Microsoft® Visual FoxPro® developers

Task List Interfaces

This part of the Task List reference describes the programming interface syntax for Microsoft® Visual FoxPro® developers.

Task List Interfaces

The following interfaces represent implementations of the Task List core interfaces.

TaskList	Represents the Task List
TaskListUI	Represents the Task List User Interface

Task List Object Interfaces

The following interfaces represent implementations of the Task List object interfaces.

exportFilter	Represents an export filter.
importFilter	Represents an import filter.
task	Represents a single Task in the Task database.

TaskList Interface

          TaskList Properties

childDataSource	Source of the child table, i.e., user-defined data
dataSource	Source of the task data
orderBy	Field or expression to order by
showTasks	Character string representing type of tasks to load
taskCount	Number of tasks in the tasks array
tasks	Array of tasks loaded
taskUI	Pointer to the user interface object

          TaskList Methods – Public Interface

addTask	Adds a task to the task database
dataObjToTask	Converts a data object created with SCATTER NAME to a task object for easy manipulation of data
getTask	Returns a reference to a task from the task database
getTaskObject	Returns a reference to an empty task object
hideUI	Hides the UI
removeTask	Removes a task from the database
setOrderBy	Sets the order by field and the direction of order
showUI	Shows the user interface
updateTask	Updates a task in the task database

          TaskList Methods – Protected Interface

buildQuery	Creates the query string based on the existence of the dataSource and childDataSource tables
forceType	Forces a character expression to a given type
getPref	Returns settings from the Foxuser table
getStandardFields	Loads the task object with the fields from the dataSource
getUDFFields	Returns an array of user-defined fields from the childDataSource
loadState	Loads state information from the resource table
openDBF	Opens and selects either the main or child data tables
openResFile	Opens and selects the resource file
requeryData	Requeries the task list data and rebuilds the tasks array
savePref	Saves information to the resource file
saveState	Saves state information to the resource file
typesAreCompatible	Determines if types are compatible. Useful when adding and updating tasks, since properties are variant and fields are strongly typed.

TaskList::addTask Method (public)

Adds a task to the task database

Visual FoxPro Syntax

cID = TaskList.addTask( oTask )

Parameters

oTask (Task object)

The task object to add to the task database

Returns

The ID of the message added, or an error code otherwise

Remarks

addTask expects a Task object. An empty Task Object reference can be obtained by calling getTaskObject.

TaskList::buildQuery Method (protected)

Builds the query statement to retrieve tasks from the database

Visual FoxPro Syntax

lResult = TaskList.buildQuery()

Parameters

None

Returns

An SQL statement that can be executed to retrieve the tasks from the task database

Remarks

Use buildQuery to build an SQL statement using the current tables and order set.

TaskList::dataObjToTask Method (public)

Converts a data object to a task object

Visual FoxPro Syntax

oTask = TaskList.dataObjToTask( oDataObj )

Parameters

oDataObj

A data object created with Scatter Name

Returns

A task object with the same data as the passed data object

Remarks

Use dataObjToTask to convert a data object to a task object.

TaskList::forceType Method (protected)

Forces a character expression to the passed type

Visual FoxPro Syntax

uValue = TaskList.forceType( cExpression, cType )

Parameters

cExpression

A character expression to convert

cType

The type to which cExpression will be converted

Returns

A value of the passed type

Remarks

forceType is used to convert a character expression to a given type.

TaskList::getPref Method (protected)