StorageLibrary StorageLibrary StorageLibrary StorageLibrary Class

Returns the StorageLibraryChangeTracker associated with the storage library.

public : StorageLibraryChangeTracker ChangeTracker { get; }public StorageLibraryChangeTracker ChangeTracker { get; }Public ReadOnly Property ChangeTracker As StorageLibraryChangeTracker// You can use this property in JavaScript.

Device family	Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v3)

Gets the folders in the current library.

public : IObservableVector<StorageFolder> Folders { get; }public IObservableVector<StorageFolder> Folders { get; }Public ReadOnly Property Folders As IObservableVector<StorageFolder>// You can use this property in JavaScript.

See Also

Library management sample (Windows 10)

Get the default save folder for the current library.

public : StorageFolder SaveFolder { get; }public StorageFolder SaveFolder { get; }Public ReadOnly Property SaveFolder As StorageFolder// You can use this property in JavaScript.

Prerelease. Determines if there are suggestions for adding existing folders with content to the StorageLibrary.

public : IAsyncOperation<PlatForm::Boolean> AreFolderSuggestionsAvailableAsync()public IAsyncOperation<bool> AreFolderSuggestionsAvailableAsync()Public Function AreFolderSuggestionsAvailableAsync() As IAsyncOperation( Of bool )// You can use this method in JavaScript.

Device family	Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v5)

Examples

This example demonstrates how to determine whether there are any suggested folders with content that can be added to your Pictures library.

private async Task<StorageLibrary> SetupPicturesLibraryAsync()
{
    if (this.picturesLibrary == null)
    {
        this.picturesLibrary = await StorageLibrary.GetLibraryAsync(KnownLibraryId.Pictures);
        this.picturesLibrary.DefinitionChanged += PicturesLibrary_DefinitionChanged;
    }
    return this.picturesLibrary;
}

private async void CheckForFolderSuggestions_Clicked(object sender, RoutedEventArgs e)
{
    var library = await SetupPicturesLibraryAsync();

    if (await library.AreFolderSuggestionsAvailableAsync())
    {
        // There are new folders that could be added to the library.
        // Prompt the user to add one or more of them. 

        // Note that the RequestAddFolderAsync method returns only one folder.
        // If the user adds multiple folders, only one will be returned.
        // In this example, to keep track of all the added folders, the app can subscribe to the
        // StorageLibrary.DefinitionChanged event by awaiting library.RequestAddFolderAsync();

        // Launch the folder suggestion dialog
        var folder = await library.RequestAddFolderAsync(); 
    }
}

private void PicturesLibrary_DefinitionChanged(StorageLibrary sender, object args)
{
    foreach (StorageFolder folder in sender.Folders)
    {
        // Do something with every folder in the library
    }
}

Remarks

If this feature is not supported on your version of Windows, the method will return false.

Gets the specified library.

public : static IAsyncOperation<StorageLibrary> GetLibraryAsync(KnownLibraryId libraryId)public static IAsyncOperation<StorageLibrary> GetLibraryAsync(KnownLibraryId libraryId)Public Static Function GetLibraryAsync(libraryId As KnownLibraryId) As IAsyncOperation( Of StorageLibrary )// You can use this method in JavaScript.

See Also

Library management sample (Windows 10)

Gets the specified library for a User.

public : static IAsyncOperation<StorageLibrary> GetLibraryForUserAsync(User user, KnownLibraryId libraryId)public static IAsyncOperation<StorageLibrary> GetLibraryForUserAsync(User user, KnownLibraryId libraryId)Public Static Function GetLibraryForUserAsync(user As User, libraryId As KnownLibraryId) As IAsyncOperation( Of StorageLibrary )// You can use this method in JavaScript.

Device family	Windows 10 (introduced v10.0.10586.0)
API contract	Windows.Foundation.UniversalApiContract (introduced v2)

See Also

KnownLibraryIdKnownLibraryIdKnownLibraryIdKnownLibraryId

Prompts the user to select a folder, and then adds the folder to the library.

public : IAsyncOperation<StorageFolder> RequestAddFolderAsync()public IAsyncOperation<StorageFolder> RequestAddFolderAsync()Public Function RequestAddFolderAsync() As IAsyncOperation( Of StorageFolder )// You can use this method in JavaScript.

Remarks

The file picker displayed lets user select only library-eligible locations.

See Also

Library management sample (Windows 10)

Prompts the user to confirm removal of the specified folder from the current library, and then removes the folder.

public : IAsyncOperation<PlatForm::Boolean> RequestRemoveFolderAsync(StorageFolder folder)public IAsyncOperation<bool> RequestRemoveFolderAsync(StorageFolder folder)Public Function RequestRemoveFolderAsync(folder As StorageFolder) As IAsyncOperation( Of bool )// You can use this method in JavaScript.

Remarks

See Also

Library management sample (Windows 10)

Occurs when the list of folders in the current library changes.

public : event TypedEventHandler DefinitionChanged<StorageLibrary,  object>public event TypedEventHandler DefinitionChanged<StorageLibrary,  object>Public Event DefinitionChanged<StorageLibrary,  object>// You can use this event in JavaScript.