TTMSFNCAppUpdate Class
Ready-to-use update component that surfaces the update configuration, pending-version information, and events at design time.
API unit family: TMSFNCAppUpdate
Inherits from: TTMSFNCCustomAppUpdate
Syntax
TTMSFNCAppUpdate = class(TTMSFNCCustomAppUpdate)
Remarks
Inherits the full update workflow from its base class and publishes the commonly used properties and events for use in the object inspector.
Properties
| Name | Description |
|---|---|
| AppInfo | Information about the available update shown to the user. (inherited from TTMSFNCCustomAppUpdate) |
| Elevate | When True, requests elevated privileges to apply updates to protected locations on Windows. (inherited from TTMSFNCCustomAppUpdate) |
| FileList | Collection of files evaluated and downloaded during the update. (inherited from TTMSFNCCustomAppUpdate) |
| Logging | Logging configuration for the update process. (inherited from TTMSFNCCustomAppUpdate) |
| NewVersion | Local version string used as the basis for version comparison. (inherited from TTMSFNCCustomAppUpdate) |
| Password | Password used to authenticate downloads. (inherited from TTMSFNCCustomAppUpdate) |
| PendingNewChecksum | Checksum detected as different during the most recent check. (inherited from TTMSFNCCustomAppUpdate) |
| PendingNewFileVersion | File version detected as newer during the most recent check. (inherited from TTMSFNCCustomAppUpdate) |
| PendingNewVersion | Version string detected as newer during the most recent check. (inherited from TTMSFNCCustomAppUpdate) |
| URL | URL of the remote control file that describes the available update. (inherited from TTMSFNCCustomAppUpdate) |
| Username | User name used to authenticate downloads. (inherited from TTMSFNCCustomAppUpdate) |
Methods
| Name | Description |
|---|---|
| DoUpdate | Checks for an available update and, when one is found, prompts the user with the configured confirmation message before starting the update; starts immediately when no message is configured. (inherited from TTMSFNCCustomAppUpdate) |
| Log | Writes a custom message to the configured log. (inherited from TTMSFNCCustomAppUpdate) |
| NewVersionAvailable | Downloads the control file and determines whether a newer version is available for the local installation. (inherited from TTMSFNCCustomAppUpdate) |
| StartUpdate | Starts the update process, downloading and applying the changed files and restarting the application when required. (inherited from TTMSFNCCustomAppUpdate) |
Events
| Name | Description |
|---|---|
| OnAppDoClose | Occurs when the application is asked to close as part of an update. (inherited from TTMSFNCCustomAppUpdate) |
| OnAppRestart | Occurs before the application is restarted to complete an update. (inherited from TTMSFNCCustomAppUpdate) |
| OnControlFileDownloaded | Occurs after the control file has been downloaded. (inherited from TTMSFNCCustomAppUpdate) |
| OnConvertPrefix | Occurs when a path placeholder prefix is resolved. (inherited from TTMSFNCCustomAppUpdate) |
| OnFileDownloaded | Occurs after an individual file has been downloaded. (inherited from TTMSFNCCustomAppUpdate) |
| OnFileNameFromURL | Occurs when a local file name is derived from a download URL. (inherited from TTMSFNCCustomAppUpdate) |
| OnFileProgress | Occurs repeatedly while a file is being downloaded. (inherited from TTMSFNCCustomAppUpdate) |
| OnVersionComparison | Occurs when two version strings are compared, allowing custom comparison logic. (inherited from TTMSFNCCustomAppUpdate) |