Provides information about the activated event that fires when the user saves or opens a file that needs updates from the app.
JavaScript: This type appears as WebUICachedFileUpdaterActivatedEventArgs.
Syntax
public sealed class CachedFileUpdaterActivatedEventArgs : Object, ICachedFileUpdaterActivatedEventArgs, IActivatedEventArgs
Attributes
- MarshalingBehaviorAttribute(Agile)
- VersionAttribute(NTDDI_WIN8)
Members
The CachedFileUpdaterActivatedEventArgs class has these types of members:
Methods
The CachedFileUpdaterActivatedEventArgs class inherits methods from the Object class.
Properties
The CachedFileUpdaterActivatedEventArgs class has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Gets the letterbox UI of the file picker that is displayed when a file needs updates from the app. | |
| Read-only | Gets the activation type. | |
| Read-only | Gets the execution state of the app before it was activated. | |
| Read-only | Gets a SplashScreen object that provides information about the transition from the splash screen to the activated app. |
Remarks
Learn more about providing updates for files that your app offers in the Quickstart: Providing file services through file pickers and in the Windows.Storage.Pickers.Provider namespace reference.
A CachedFileUpdaterActivatedEventArgs object is passed to the app's activated event handler when the user saves a file that requires content management from the app. This type of activation is indicated by the ActivationKind.CachedFileUpdater value returned by the Kind property.
Apps written in JavaScript must listen for and handle Windows.UI.WebUI.WebUIApplication.activated events.
Windows Store apps built for Windows using C++, C#, or Visual Basic typically implement activation points by overriding methods of the Application object. The default template app.xaml code-behind files always include an override for OnLaunched, but defining overrides for other activation points such as OnCachedFileUpdaterActivated is up to your app code.
All Application overrides involved in an activation scenario should call Window.Activate in their implementations.
Examples
The File picker contracts sample demonstrates how to respond to a CachedFileUpdater activation point.
// CachedFileUpdater activated event handler protected override void OnCachedFileUpdaterActivated(CachedFileUpdaterActivatedEventArgs args) { var CachedFileUpdaterPage = new SDKTemplate.CachedFileUpdaterPage(); CachedFileUpdaterPage.Activate(args); } // Overloaded method to respond to CachedFileUpdater events public void Activate(CachedFileUpdaterActivatedEventArgs args) { // Get file picker UI cachedFileUpdaterUI = args.CachedFileUpdaterUI; cachedFileUpdaterUI.FileUpdateRequested += CachedFileUpdaterUI_FileUpdateRequested; cachedFileUpdaterUI.UIRequested += CachedFileUpdaterUI_UIRequested; switch (cachedFileUpdaterUI.UpdateTarget) { case CachedFileTarget.Local: scenarios = new List<Scenario> { new Scenario() { Title = "Get latest version", ClassType = typeof(FilePickerContracts.CachedFileUpdater_Local) } }; break; case CachedFileTarget.Remote: scenarios = new List<Scenario> { new Scenario() { Title = "Remote file update", ClassType = typeof(FilePickerContracts.CachedFileUpdater_Remote) } }; break; } Window.Current.Activate(); }
For C#, args for an OnCachedFileUpdaterActivated override on the Application object references a CachedFileUpdaterActivatedEventArgs object. The OnCachedFileUpdaterActivated override is in the App.xaml.cs file and the Activate method is in the CachedFileUpdaterPage.xaml.cs file of the File picker contracts sample.
Requirements
|
Minimum supported client | Windows 8 [Windows Store apps only] |
|---|---|
|
Minimum supported server | Windows Server 2012 [Windows Store apps only] |
|
Namespace |
|
|
Metadata |
|
See also
- ActivationKind enumeration
- Windows.Storage.Provider namespace
- File picker contracts sample
- Reference
- Windows.UI.Core.CoreApplicationView.Activated event
- OnCachedFileUpdaterActivated
- Application
Build date: 2/25/2013