MFiles.VAF.Extensions 23.4.0.68-CustomCommandAttribute

Prefix Reserved
This is a prerelease version of MFiles.VAF.Extensions.
There is a newer version of this package available.
See the version list below for details.
dotnet add package MFiles.VAF.Extensions --version 23.4.0.68-CustomCommandAttribute
                    
NuGet\Install-Package MFiles.VAF.Extensions -Version 23.4.0.68-CustomCommandAttribute
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MFiles.VAF.Extensions" Version="23.4.0.68-CustomCommandAttribute" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MFiles.VAF.Extensions" Version="23.4.0.68-CustomCommandAttribute" />
                    
Directory.Packages.props
<PackageReference Include="MFiles.VAF.Extensions" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add MFiles.VAF.Extensions --version 23.4.0.68-CustomCommandAttribute
                    
#r "nuget: MFiles.VAF.Extensions, 23.4.0.68-CustomCommandAttribute"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package MFiles.VAF.Extensions@23.4.0.68-CustomCommandAttribute
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=MFiles.VAF.Extensions&version=23.4.0.68-CustomCommandAttribute&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=MFiles.VAF.Extensions&version=23.4.0.68-CustomCommandAttribute&prerelease
                    
Install as a Cake Tool

M-Files Vault Application Framework Extensions library

Please note that this library is provided "as-is" and with no warranty, explicit or otherwise. You should ensure that the functionality meets your requirements, and thoroughly test them, prior to using in any production scenarios.

The following helper library is a community-driven set of functionality that extends the base M-Files Vault Application Framework. This library is open-source and not directly supported by M-Files. Contributions are accepted according to our contribution guide.

Using the library

  1. Install the latest production release from nuget.
  2. Update your VaultApplication.cs file, ensuring that your vault application inherits from MFiles.VAF.Extensions.ConfigurableVaultApplicationBase<T>. A more complete example of an empty vault application class is shown below.
  3. Ensure that your Configuration.cs file inherits from MFiles.VAF.Configuration.ConfigurationBase. A more complete example of an empty configuration class is shown below.
public class VaultApplication
	: MFiles.VAF.Extensions.ConfigurableVaultApplicationBase<Configuration>
{

}
public class Configuration
	: MFiles.VAF.Configuration.ConfigurationBase
{

}

Naming formats

Releases follow a naming format based upon the M-Files versioning; releases are named using a combination of the year and month they are released in and an incrementing build number. Releases may also optionally contain a suffix (starting with a hyphen) denoting that the release is a preview release and should not be used in production environments.

  • 22.6.123 - this full release was made in June 2022. Full releases come from the release branch.
  • 22.6.140 - this full release was also made in June 2022, but is newer than the one above.
  • 22.7.141-preview - this release was made in July 2022 from the main branch. Releases from the main branch are often close to release quality, but should only be used for testing.
  • 22.7.0.13-test-feature-1 - this release was made in July 2022 from a specific feature branch. This release will contain in-development functionality and should only be used when needing to test the specific feature being developed. Significant breaking changes may still be made when this functionality progresses to preview or release builds.

Any problems can be logged as issues against the repository, or discussed on the M-Files Community.

Product Compatible and additional computed target framework versions.
.NET Framework net472 is compatible.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on MFiles.VAF.Extensions:

Package Downloads
CtrlVAF.Core

An extensive framework, made to make your life as an M-Files VAF engineer much more simple, powerful and S.O.L.I.D

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
24.12.75 3,855 12/4/2024
24.11.74 747 11/6/2024
24.10.73 823 10/23/2024
24.10.72 227 10/22/2024
24.10.0.7-issue-141 144 10/29/2024
24.10.0.6-issue-141 168 10/27/2024 24.10.0.6-issue-141 is deprecated.
24.10.0.5-issue-138 130 10/23/2024
24.6.71 2,663 6/17/2024
24.5.70 695 5/30/2024
24.4.69 726 4/26/2024
24.4.68 496 4/12/2024
24.4.0.4-timezone-issues 145 4/22/2024
24.2.67 1,923 2/21/2024
24.2.66 197 2/21/2024
24.2.65 541 2/16/2024
24.1.64 10,400 1/24/2024
24.1.63 264 1/18/2024
23.12.62 1,283 12/11/2023
23.12.0.3-confupgrade-optin 172 12/12/2023
23.11.61 914 11/10/2023
23.11.60 203 11/10/2023
23.11.0.2-prerelease 204 11/14/2023
23.11.0.1-prerelease 157 11/14/2023
23.9.59 1,731 9/27/2023
23.8.0.73-timestamp-search-... 203 8/4/2023
23.7.58 7,947 7/17/2023
23.7.57 277 7/14/2023
23.7.56 273 7/14/2023
23.7.0.72-issue-110 211 7/20/2023
23.7.0.70-issue-108 192 7/14/2023
23.7.0.69-leave-json-alone-... 206 7/7/2023
23.6.55 1,092 6/7/2023
23.5.54 369 5/31/2023
23.5.53 939 5/3/2023
23.4.52 581 4/27/2023
23.4.51 331 4/27/2023
23.4.50 915 4/17/2023
23.4.0.68-CustomCommandAttr... 197 4/24/2023
23.2.0.67-configupgrading-d... 286 2/24/2023
23.2.0.63-prerelease 250 2/15/2023
23.2.0.62-jsonconfeditor-ed... 229 2/9/2023
23.1.49 1,861 1/18/2023
23.1.47 795 1/17/2023
22.12.54 2,470 12/16/2022
22.12.52 521 12/12/2022
22.12.46 456 12/16/2022
22.12.45 483 12/12/2022
22.11.49-prerelease 321 11/10/2022
22.11.47-prerelease 290 11/2/2022
22.11.44 990 11/28/2022
22.11.43 721 11/10/2022
22.9.41 9,500 9/14/2022
22.9.37 803 9/8/2022
22.6.31 2,296 6/20/2022
22.6.29 741 6/10/2022
22.5.27 1,420 5/3/2022
22.5.26 605 5/3/2022
22.5.0.15-configuration-mig... 282 5/24/2022
22.5.0.13-configuration-mig... 277 5/13/2022
22.5.0.12-configuration-mig... 282 5/9/2022
22.4.24 789 4/29/2022
22.4.23-preview 338 4/14/2022
22.3.20-preview 301 3/30/2022
22.3.18-preview 396 3/9/2022
22.3.17-preview 300 3/7/2022
22.3.16-preview 285 3/7/2022
22.3.15-preview 294 3/7/2022
22.3.14-preview 276 3/3/2022
22.3.13-preview 272 3/2/2022
22.2.11-preview 337 2/11/2022
22.2.10-preview 263 2/11/2022
22.2.9-preview 298 2/10/2022
22.2.8-preview 316 2/3/2022
22.2.7-preview 286 2/2/2022
1.3.1.5 1,397 2/28/2022
1.3.1.3 1,429 1/12/2022
1.3.1.1 499 1/4/2022
1.3.1-prerelease 301 1/4/2022
1.3.0.16 665 12/8/2021
1.3.0.15 483 12/3/2021
1.3.0.14 742 10/21/2021
1.3.0.13 617 10/7/2021
1.3.0.10 9,446 9/29/2021
1.3.0.9 739 9/24/2021 1.3.0.9 is deprecated because it has critical bugs.
1.2.11.5 1,120 7/2/2021
1.2.11.4 771 6/24/2021
1.2.11.3 745 6/1/2021
1.2.11.2 679 5/21/2021
1.2.10.2 1,309 5/12/2021
1.1.13 659 3/23/2021
1.1.11 656 3/15/2021
1.1.10 928 3/2/2021
1.1.9 1,620 1/22/2021
1.1.8 679 12/16/2020
1.1.7 865 11/2/2020
1.1.6 745 10/8/2020
1.1.5 662 10/1/2020
1.0.7 814 7/8/2020
1.0.6-alpha 1,382 7/2/2020
1.0.5-alpha 504 6/29/2020
1.0.4 716 6/11/2020
0.2.3.3-alpha 527 5/19/2020
0.2.3.2-alpha 487 4/27/2020
0.1.8-alpha 514 4/6/2020
0.1.7-alpha 519 4/3/2020
0.1.6-alpha 494 4/1/2020
0.1.5-alpha 507 3/23/2020
0.1.3-alpha 484 3/12/2020
0.1.2-alpha 491 3/10/2020
0.1.1-alpha 492 3/2/2020

Changes included in 23.4.0.68-CustomCommandAttribute
https://github.com/M-Files/VAF.Extensions.Community/commit/19f9eb7f748944a2d6fe0f91628b498d41c30cea
Split AggregatedCustomDomainCommandResolver to separate file.
Added DefaultCustomDomainCommandResolver<T>.
Moved the resolving of all custom domain commands - including task queues and the like - to the (new) default generic custom domain command resolver.
https://github.com/M-Files/VAF.Extensions.Community/commit/e53b6fb47cfbe709a1561eff5d0cafd47349134f
Split GetCustomDomainCommands into separate methods.
https://github.com/M-Files/VAF.Extensions.Community/commit/f5ce3723babf608454763fc405a07f1a6fb92398
Moved logic out of CustomCommandAttribute and into virtual methods in the resolver, for ease of overriding.
https://github.com/M-Files/VAF.Extensions.Community/commit/03c09f763263ba13cd31d9aed2f748fa34c97438
Exceptions not thrown if the method signature is invalid (logged instead).
Fix for logging data not appearing in test runs.
https://github.com/M-Files/VAF.Extensions.Community/commit/a45d53b6de71a7734a469c88e9c9649f3bf8b1d4
Added lots of examples.
Enabled command to be rendered within a dashboard.
https://github.com/M-Files/VAF.Extensions.Community/commit/911efd480fc111e13bd930ffda6714bdda101181
Added usage samples to the readme.
https://github.com/M-Files/VAF.Extensions.Community/commit/86d8dc13866fb5fa382b2b410900bd439de3a210
Comments for tests.
Fix for static method unit test.
https://github.com/M-Files/VAF.Extensions.Community/commit/344f9badd2b1589fff1fd079699bbe539ca1e3ed
Fix for broken test.
https://github.com/M-Files/VAF.Extensions.Community/commit/31d4bb419e6cd70e37e2a1616d72f91851c96445
Fix for binding flags not being used.
https://github.com/M-Files/VAF.Extensions.Community/commit/6dda8b56cba383ed285563f0df8f41f7fe1c355f
DefaultCustomDomainCommandResolver.Included moved to dictionary (type is used in command ID, so two instances cannot be added of the same type).
Added unit tests to describe behaviour when overriding.
https://github.com/M-Files/VAF.Extensions.Community/commit/9ec522026b662add0340563eb4cc9d7ab0aaebb5
Split out resolving of domain commands to separate resolver class.
Started adding unit tests.
https://github.com/M-Files/VAF.Extensions.Community/commit/cd6805a40acce41023da88ce7cae9cb0b726adde
Initial commit.  Lacks examples in the readme.