A collection is a container for a given entity type and configures how the given entity should display in a tree or list view as well as how it should be edited.
You define a collection by calling one of the AddCollection methods on a given FluidityTreeConfig or parent FluidityFolderConfig instance.
Adds a collection to the given container with the given names and description and default icons. An ID property accessor expression is required so that Fluidity knows which property is the ID property.
// Example
folderConfig.AddCollection<Person>(p => p.Id, "Person", "People", "A collection of people", collectionConfig => {
...
});
Adds a collection to the given container with the given names, description and icons. An ID property accessor expression is required so that Fluidity knows which property is the ID property.
// Example
folderConfig.AddCollection<Person>(p => p.Id, "Person", "People", "A collection of people", "icon-umb-users", "icon-umb-users", collectionConfig => {
...
});
Sets the alias of the collection.
Optional: When creating a new collection, an alias is automatically generated from the supplied name for you, however you can use the SetAlias method to override this should you need a specific alias.
// Example
collectionConfig.SetAlias("person");
Sets the collection icon color to the given color. Possible options are black, green, yellow, orange, blue or red.
// Example
collectionConfig.SetIconColor("blue");
By default Fluidity will use the Umbraco connection string for it’s database connection however you can change this by calling the SetConnectionString method on a FluidityCollectionConfig instance.
Sets the connection string name for the given collection repository.
// Example
collectionConfig.SetConnectionString("myConnectionStringName");
By default Fluidity will use a PetaPoco based repository for storing and fetching entities however you can implement your own repository should you need to store your entities via another strategy. To change the repository implementation used by a collection you can use the SetRepositoryType method. See Repositories API documentation for more info.
Sets the repository type to the given type for the current collection.
// Example
collectionConfig.SetRepositoryType<PersonRepositoryType>();
Sets the repository type to the given type for the current collection.
// Example
collectionConfig.SetRepositoryType(typeof(PersonRepositoryType));
Within Umbraco it is expected that an entity has a name property so we need to let Fluidity know which property to use for the name or if our entity doesn’t have a single name property, then how to construct a name from an entities other properties. We do this by using either the SetNameProperty or SetNameFormat methods on a FluidityCollectionConfig instance.
Sets which property of our entity to use as the name property. Property must be of type string. By defining a property as the name property, it’s value will be used as the label for the entity in things like trees and list views and will also be editable in the header region of the editor interface. The property will also automatically be added to the searchable properties collection and be used for the default sort property.
// Example
collectionConfig.SetNameProperty(p => p.Name);
Sets a format expression to use to dynamically create a label for the entity in things like trees and list views. By providing a name format it is assumed there is no single name property available on the entity and as such none of the default behaviours descriped for the SetNameProperty method will apply.
// Example
collectionConfig.SetNameFormat(p => $"{p.FirstName} {p.LastName}");
Sets which property of our entity to use as the date created property. Property must be of type DateTime. When set and a new entity is saved via the Fluidity repository, then the given field will be populated with the current date and time.
// Example
collectionConfig.SetDateCreatedProperty(p => p.DateCreated);
Sets which property of our entity to use as the date modified property. Property must be of type DateTime. When set and an entity is saved via the Fluidity repository, then the given field will be populated with the current date and time.
// Example
collectionConfig.SetDateModifiedProperty(p => p.DateModified);
By default in Fluidity any entity that is deleted via the Fluidity repository is completely removed from the system. In some occasions however you may wish to keep the records in the data repository but just mark them as deleted so that they don’t appear in the UI. This is where the SetDeletedProperty method comes in handy.
Sets which property of our entity to use as the deleted property flag. Property must be of type boolean. When a deleted property is set, any delete actions will set the deleted flag instead of actualy deleting the entity. In addition, any fetch actions will also pre-filter out any deleted entities.
// Example
collectionConfig.SetDeletedProperty(p => p.Deleted);
Sets which property of our entity to sort against, defaulting to ascending sort direction.
// Example
collectionConfig.SetSortProperty(p => p.FirstName);
Sets which property of our entity to sort against in the provided sort direction.
// Example
collectionConfig.SetSortProperty(p => p.FirstName, SortDirection.Descending);
Adds the given property to the searchable properties collection. Property must be of type String. When set searches via the list view search and entity picker property editor search fields will search across the properties defined in this collection. If no properties are defined as searchable then these UI elements will be disabled.
// Example
collectionConfig.AddSearchableProperty(p => p.FirstName);
Adds the given property to the encrypted properties collection. Property must be of type String. When set, the property will be encrypted/decrypted on write/read respectively.
// Example
collectionConfig.AddEncryptedProperty(p => p.Email);
Sometimes you may only want to work with a sub-set of data within a given table so this is where the SetFilter method comes in handy, allowing you to define a global filter to apply to all queries for the given collection.
Sets the filter where clause expression. Expression must be a boolean expression.
// Example
collectionConfig.SetFilter(p => p.Current);
See Menu Items API documentation for more info.
Adds a menu item of the given type to the collection tree node right click menu as well as the list view actions menu.
// Example
collectionConfig.AddContainerMenuItem<ExportMenuItem>();
Adds the provided menu item to the collection tree node right click menu as well as the list view actions menu.
// Example
collectionConfig.AddContainerMenuItem(new ExportMenuItem());
Adds a menu item of the given type to the entity tree node right click menu as well as the entity editor actions menu.
// Example
collectionConfig.AddEntityMenuItem<ExportMenuItem>();
Adds the provided menu item to the entity tree node right click menu as well as the entity editor actions menu.
// Example
collectionConfig.AddEntityMenuItem(new ExportMenuItem());
When navigating to a Fluidity section you are automatically presented with a dashboard interface on which you can add your collections to. This dashboard gives a quick entry point to frequently used collections showing the number of items in the collection as well as links to it’s list view (if one is defined) as well as a quick create link (if the collection isn’t read only).
Sets the collection to display on the section dashboard.
// Example
collectionConfig.ShowOnDashboard();
Sets the collection as read only and disables any CRUD operations from being performed on the collection via the UI.
// Example
collectionConfig.MakeReadOnly();
Sets the view mode of the current collection. Opions are Tree or List. When set to Tree then all entities will appear as nodes in the tree. When set as List then entities will be hidden from the tree and show in a list view in the right hand content area.
// Example
collectionConfig.SetViewMode(FluidityViewMode.List);
Accesses the list view config of the current collection. See List View API documentation for more info.
// Example
collectionConfig.ListView(listViewConfig => {
...
});
Accesses the editor config of the current collection. See Editor API documentation for more info.
// Example
collectionConfig.Editor(editorConfig => {
...
});