The Project class represents a project that is open within Mobile Data Studio.

It can be used to examine the design of the project, by accessing its Pages and Points() properties, or it can be used as a jumping off point to manage session data via its Database property.

Properties

Application

Returns the root Application.

AsXML

Returns an XML description of the project, as a String.

Author

A String value, project properties. Read/write.

Database

Returns the project's session Database.

Company

A String value, project properties. Read/write.

Copyright

A String value, project properties. Read/write.

CurrentSession

Returns the Session object that is open locally on the server.

Check that the Running property is True before accessing this property.

Dirty

A Boolean value indicating whether the project has been modified and needs to be saved. Read/write.

Notes

A String value, project properties. Read/write.

Pages

Returns a PageCollection that represents the Page objects in the project.

Path

Returns a String value that is the filename of the project, including directory.

Points()

This is a named indexer property, which takes one String parameter:

• PointIDName - a String specifying the point ID name to lookup from the project.

Returns the Point object with that ID name, if it exists within the project.

Running

Returns a Boolean that is True if a session from this project is open locally on the server.

If so, the current session can be accessed via the CurrentSession property.

Title

A String value, project properties. Read/write.

Unique

Returns an Integer value that uniquely identifies the project to some extent.

WebURL

A String value, project properties. Read/write.

Methods

ExportToXML

Expots the project to an XML file on disk, in .ppcx format.

Takes one parameter:

• filename - a String that is the filename of a .ppcx XML project file to write to.

NewMailer

Constructs a new Mailer object.

Takes no parameters.

NewTelegram

Constructs a new Telegram object associated with this project.

Can be used to send live data updates to mobile devices in the field, see documentation for that class.

Takes no parameters.

Save

Saves the project to its .ppc file on disk, and clears the Dirty property.

Note that this method may display an error message dialog if the save fails, blocking further script execution. See SaveNonInteractive.

Takes no parameters.

SaveNonInteractive

Saves the project to its .ppc file on disk, and clears the Dirty property. Will not display UI.

Takes no parameters.

SendToDevice

Sends the latest version of the project to that device, or fails with an error if the device is not connected.

Takes one parameter:

• UnitID - a String specifying the UnitID of the mobile device to send the project to.