The programming interface syntax for Microsoft® Visual FoxPro® developers, страница 2

Loads information stored in FoxUser

Visual FoxPro Syntax

lResult = TaskList.getPref( cID, cPubList )

Parameters

cID

The ID of the record in FoxUser containing the information to restore. Valid values are: PREF_COLUMNS, PREF_FORMINFO, PREF_ORDERBY, and PREF_STATE

          cPubList

A comma-delimited list of memory variables that should be restored as public variables. getPref uses Restore From to retrieve information. Restore From does not create public variables, but will not change the scope of variables that are declared public when restored.

Returns

True if the restore was successful, false if not.

Remarks

getPref is used to retrieve information from FoxUser, such as column sets, form settings, order by settings and other state information.

TaskList::getStandardFields Method (protected)

getStandardFields returns an array of field information from the primary task table

Visual FoxPro Syntax

nFieldCount = TaskList.getStandardFields( @ aFieldArray )

Parameters

@ aFieldArray

An empty array passed by reference. The contents of the array will be overwritten by the function.

Returns

The number of fields detected in the primary task table

Remarks

getStandardFields is used to create properties for a task object.

TaskList::getTask Method (public)

Returns a reference to a task from the task database

Visual FoxPro Syntax

oTask = TaskList.getTask( cID )

Parameters

cID (text)

The ID of the task to return

Returns

A task object representing the first task encountered that meets the passed criteria.

Remarks

Use getTask to retrieve a particular task record from the task database.

TaskList::getTaskObject Method (public)

Returns an empty task object

Visual FoxPro Syntax

oEmptyTask = TaskList.getTaskObject()

Parameters

None

Returns

An empty task object.

Remarks

Use getTaskObject to return a reference to an empty task object. This object can then be inserted into the task database by calling addTask.

TaskList::getUDFFields Method (protected)

getUDFFields returns an array of field information from the child task table

Visual FoxPro Syntax

nFieldCount = TaskList.getUDFFields( @ aFieldArray )

Parameters

@ aFieldArray

An empty array passed by reference. The contents of the array will be overwritten by the function.

Returns

The number of fields detected in the child task table

Remarks

getStandardFields is used to create properties for a task object.

TaskList::hideUI Method (public)

hideUI hides the user-interface

Visual FoxPro Syntax

void = TaskList.hideUI()

Parameters

None

Returns

void

Remarks

Use hideUI to programmatically hide the user interface.

TaskList::loadState Method (protected)

loadState loads state information about the TaskList from FoxUser

Visual FoxPro Syntax

void = TaskList.loadState()

Parameters

None

Returns

void

Remarks

loadState is used to load order by, and show tasks information.

TaskList::openDBF Method (protected)

openDBF opens either the Primary or Child table for use by the TaskList.

Visual FoxPro Syntax

lOpened = TaskList.openDBF( nType )

Parameters

nType

Type of table to open. Possible values are OPEN_MAIN, or OPEN_CHILD.

Returns

True if the requested table was opened successfully. False if the table was not opened.

Remarks

openDBF is used each time the table will be accessed.

TaskList::openResFile Method (protected)

Opens the resource file for use.

Visual FoxPro Syntax

lOpened = TaskList.openResFile()

Parameters

None

Returns

True if the resource file was opened successfully, false if not.

Remarks

openResFile is used by getPref and savePref.

TaskList::removeTask Method (public)

Removes a task from the database.

Visual FoxPro Syntax

void = TaskList.removeTask( cID )

Parameters

cID

The unique ID of the task to delete. If the ID is not found the request is ignored.

Returns

void

Remarks

Use removeTask to remove a task from the database.

TaskList::requeryData Method (protected)

requeryData loads the most recent task information from the database.

Visual FoxPro Syntax

void = TaskList.requeryData()

Parameters

None

Returns

void

Remarks

requeryData is used frequently to refresh the TaskList engine.

TaskList::savePref Method (protected)

Saves information to the resource file

Visual FoxPro Syntax

lSaved = TaskList.savePref( cID )

Parameters

cID

The record identifier to update. Valid values are PREF_COLUMNS, PREF_FORMINFO, PREF_ORDERBY, and PREF_STATE.

Returns

True if the information was successfully saved, false if not.

Remarks

savePref is used to save infromation about the TaskList engine.