YngveHestem.GenericParameterCollection.Avalonia 1.0.1

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package YngveHestem.GenericParameterCollection.Avalonia --version 1.0.1                

                    
                

            
NuGet\Install-Package YngveHestem.GenericParameterCollection.Avalonia -Version 1.0.1
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="YngveHestem.GenericParameterCollection.Avalonia" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add YngveHestem.GenericParameterCollection.Avalonia --version 1.0.1                

                    
                

            
#r "nuget: YngveHestem.GenericParameterCollection.Avalonia, 1.0.1"
#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. 
// Install YngveHestem.GenericParameterCollection.Avalonia as a Cake Addin
#addin nuget:?package=YngveHestem.GenericParameterCollection.Avalonia&version=1.0.1

// Install YngveHestem.GenericParameterCollection.Avalonia as a Cake Tool
#tool nuget:?package=YngveHestem.GenericParameterCollection.Avalonia&version=1.0.1

GenericParameterCollection.Avalonia

This provides controls for using GenericParameterCollection in the UI-toolkit Avalonia.

How to use this package

The easiest way to use the package is to download it from nuget.

Main features/controls

ParameterCollectionView

This is the main control that handles editing a given ParameterCollection object.

Properties and events

Here is a list of properties and events of the ParameterCollectionView-component.

ParameterCollection

Set this to the ParameterCollection the component should render.

Options

This property let you set customized Options for how the ParameterCollectionView should look and behave.

OnChange-event

This event is triggered each time the user do a change in the component.

When the event is triggered you will get an object that will contain both the new ParameterCollection, and the key to the parameter that was changed.

CustomParameterComponents

Here you can define a list of custom component definitions.

This can be good to use if you for instance want a color picker for picking some colors, or have your own component you want to use for some parameter.

CustomConverters

Do you have some custom converters you need to use for converting some custom value, or want to change how some value is converted in the ParameterCollectionView? Then you can define a list of theese here.

Example code

Please see the TestProject for some example-codde on how you can use it (https://github.com/HeruEwasham/GenericParameterCollection.Avalonia/blob/main/Testproject.Desktop/MainWindow.axaml.cs). Mark that this is only one way to do it.

The Testproject uses two ParameterCollectionViews (the main one, and the options-one), and if you change the options-one, it will update the main with the changed options.

Options

The controls let you provide a ParameterCollectionViewOptions. Here you can define some customisation of how the control looks and works. Most are both self explanatory and well documented in code. Most of theese options can also be set for a specific parameter if the option AdditionalInfoWillOverride is set to true (default is true). Then one or more of the given parameters below can be given in a parameters additionalInfo.

Different options

Here is a list of parameters that can either be defined in ParameterCollectionViewOptions or as a ParameterCollection (some can only be given in one, while many can be given both ways).

If you define this in a ParameterCollection-ParameterType, the changes will affect all parameters in that ParameterCollection.

Variable name in option-class Parameter key Type Description Default value in option-class
AdditionalInfoWillOverride additionalInfoWillOverride bool Can parameters from a ParameterCollection, like AdditionalInfo from a parameter, override the values defined in this options-object. Mark that if this is set to false in the Options-object that it uses as a base, this will have no effect. true
ShowParameterNameAsHumanReadable humanReadable bool Convert the parameter name to a human readable format. If set to false, the name will be shown as written, while if set to true, it will be altered to be read easily by a human, like setting first character to an upper character. Mark that this will only have an effect if it is the parameter key that is used. If another name is given, that will always be written as is. True
ReadOnly readOnly bool If true, the control that shows the parameters value should be read only/disabled False
ReadableParameterTextKey readableParameterTextKey string Specifies a parameter key to a parameter in a parameters additional info to use instead of the parameters key to show to the user. If the specified parameter can not be found (or converted to string), the given parameter's key is instead used. name
TooltipParameterTextKey tooltipParameterTextKey string Specifies a parameter key to a parameter in a parameters additional info to use for a tooltip. tooltip
MinNumber minNumber decimal Specifies what the lowest number that can be entered in a number-field is. decimal.MinValue
MaxNumber maxNumber decimal Specifies what the highest number that can be entered in a number-field is. decimal.MaxValue
StepInteger and StepDecimal step decimal Defines how much a number (both integers and decimals) should increment/decrement with if the increment/decrement buttons are used if int, 1, if a decimal-number, 0.1
StepInteger stepInt int Specifies how much the gui should increment the value on an int value if the step-button is pressed. 1
StepDecimal stepDecimal decimal Specifies how much the gui should increment the value on a decimal value if the step-button is pressed. 0.1
NumberFormatInt and NumberFormatDecimal numberFormat string Defines how both integers and decimals should be shown. if int, "0", if a decimal-number, "0.00"
NumberFormatInt numberFormatInt string Specifies how the int numbers should be shown. 0
NumberFormatDecimal numberFormatDecimal string Specifies how the decimal numbers should be shown. 0.00
PlaceholderText placeholder string Specifies the placeholder text on controls that support that. string.Empty
IsPassword isPassword bool Specifies if strings should be shown as password (without readable characters). false
MaxNumberOfCharacters maxChars int? Specifies max number of characters that can be given in a text. null
TextAreaHeight textareaHeight double Specifies the height of a textarea. 100
TextAreaWidth textareaWidth double? Specifies the width of a textarea. Null means that the default length will be used. null
SupportedFileExtensions supportedExtensions string[] Defines what types of file extensions is supported when selecting files for ParameterType.Bytes. All must have a leading . Empty string[] or null means all types supported/no filter added
filename string This can be added to a Bytes-parameter to give information on what the filename of the file was. This is just for cosmetics and is not neccessarry (but will provide info to the user). When a Bytes-parameter is updated, this parameter in Additionalinfo will also be added/updated by the editor (so if you want to know the filename and uses this editor, this parameter will give you that info)
extension string The file extension for the filetype a Bytes-parameter has. The value should have a leading . This parameter is most likely needed if a preview of the file is wanted. This parameter in Additionalinfo will also be added/updated by the editor when the Bytes-parameter is updated
ChooseFileText chooseFileText string Specifies the text to show on the Choose file button. Choose file
DeleteFileText deleteFileText string Specifies the text to show on the Delete file button. Delete
MaxFileSize maxFileSize int Specifies the max file size allowed. 5 * 1024 * 1024
FilePreviewHeight previewHeight int Specifies the height of the file preview. 300
FilePreviewWidth previewWidth int Specifies the width of the file preview. 500
FileTypeMappings FileType[] List of different file types and mappings between extensions, UTType (UTI) and mime-types. All file extensions in SupportedFileExtensions must be defined here to be supported. Default value is all the values that is defined in the library used. Check for yourself if you need to add your own values.
MinDate minDate DateTime The earliest date that is possible to pick. DateTime.MinValue.Add(TimeSpan.FromHours(12));
MaxDate maxDate DateTime The latest date that is possible to pick. DateTime.MaxValue.Add(TimeSpan.FromHours(-12));
DateFormatDay dateFormatDay string Specifies how the format of the day is on Date and DateTime-parameters. dd
DateFormatMonth dateFormatMonth string Specifies how the format of the month is on Date and DateTime-parameters. MMMM
DateFormatYear dateFormatYear string Specifies how the format of the year is on Date and DateTime-parameters. yyyy
MinutesStep minutesStep int Specifies how much the gui should increment the minute when the minute step is clicked. 1
ClockIdentifier clockIdentifier string Specifies if the timer in a DateTime should be 12 or 24 hours. It need to either be "12HourClock" or "24HourClock". 24HourClock
AddEntryToListText addEntryToListText string Specifies the text on the button to add a new object to the list. Add
DeleteEntryFromListText deleteEntryFromListText string Specifies the text on the button to delete the given object from the list. Delete
DeleteEntryFromListAriaDescription deleteEntryFromListAriaDescription string Specifies the text used to describe the delete button on the given entry in a list for screen readers. You can use {0} to get the current number the entry are in the list, use {1} to get the parameters viewable name and {2} to get the current value. Delete entry number {0} from the list in parameter "{1}". The entry has the value "{2}".
AddEntryToListAriaDescription addEntryToListAriaDescription string Specifies the text used to describe the add button to add a new entry in a list for screen readers. You can use {0} to get the parameters viewable name. Add a new entry to the list in parameter "{0}".
defaultValue TValue (Generic baseed on value (IEnumerable)) This is used on IEnumerable-types to define their Default-value (which is their initial state when adding new value). If not defined, this will either be default(TValue) or String.Empty if TValue is string or DateTime.Now if TValue is DateTime.
parametersIf:true ParameterCollection Any parameters specified here in a bool-parameter will be shown and be editable (if not set to readonly), if the value is set to true. If set to false (or null), this will not be shown.
parametersIf:false ParameterCollection Any parameters specified here in a bool-parameter will be shown and be editable (if not set to readonly), if the value is set to false. If set to true (or null), this will not be shown.
parametersIf:null ParameterCollection Any parameters specified here in a bool-parameter will be shown and be editable (if not set to readonly), if the value is set to null. If set to true or false, this will not be shown.
ParentTypeWhenHavingExtraParameters parentTypeWhenHavingExtraParameters ExtraParametersParentType Defines how any parent component is shown when using "extra parameters" like "parametersIf:true" and "parametersIf:false". Possible valuees are None, Border, BorderWithoutName, Expander None
ExtraParametersName extraParametersName string Specifies the text used on the the collection of extra parameters (not all ParentTypeWhenHavingExtraParameters-options use it). You can use {0} to get the parameterName of the main parameter and use {1} to get the value of the main parameter. Extra parameters when {0} is {1}
parametersIf:true:name string Specifies the text used on the the collection of extra parameters if value is true (not all ParentTypeWhenHavingExtraParameters-options use it). If set, this will be used instead of ExtraParametersName.
parametersIf:false:name string Specifies the text used on the the collection of extra parameters if value is false (not all ParentTypeWhenHavingExtraParameters-options use it). If set, this will be used instead of ExtraParametersName.
parametersIf:null:name string Specifies the text used on the the collection of extra parameters if value is null (not all ParentTypeWhenHavingExtraParameters-options use it). If set, this will be used instead of ExtraParametersName.
parametersIf:true:options ParameterCollection Any parameters specified here that corresponds to the given parameter name for an option in the option-class, will alter the options inputted to the shown ParameterCollection (the same way that adding parameter to a parameters AdditionalInfo).
parametersIf:false:options ParameterCollection Any parameters specified here that corresponds to the given parameter name for an option in the option-class, will alter the options inputted to the shown ParameterCollection (the same way that adding parameter to a parameters AdditionalInfo).
parametersIf:null:options ParameterCollection Any parameters specified here that corresponds to the given parameter name for an option in the option-class, will alter the options inputted to the shown ParameterCollection (the same way that adding parameter to a parameters AdditionalInfo).
parametersIf:VALUE ParameterCollection Any parameters specified here in an Enum-, SelectOne or SelectMany-parameter will be shown and be editable (if not set to readonly), if the value is set to the value specified as VALUE. Remember that VALUE-part of the name need to be exactly as the value (including uppercase/lowercase, etc.)
parametersIf:VALUE:name string Specifies the text used on the the collection of extra parameters if value is VALUE (not all ParentTypeWhenHavingExtraParameters-options use it). If set, this will be used instead of ExtraParametersName.
parametersIf:VALUE:options ParameterCollection Any parameters specified here that corresponds to the given parameter name for an option in the option-class, will alter the options inputted to the shown ParameterCollection (the same way that adding parameter to a parameters AdditionalInfo).
SelectManyExtraParametersGetOwnParent selectManyExtraParametersGetOwnParent bool Should each extra parameter-collection (one for each value that has one), get it's own visible parent. true
SelectManyExtraParametersName selectManyExtraParametersName string Specifies the text used on the the total collection of extra parameters for SelectMany-parameters (not all ParentTypeWhenHavingExtraParameters-options use it). You can use {0} to get the parameterName of the main parameter. Extra parameters when {0} has theese values
prettyValues ParameterCollection Let you change the values shown to the user on Enum-, SelectOne- and SelectMany-parameter to something other. The value gotten back and sent in must be the correct value. This can be useful if you want to support multiple languages or if you just want to show prettier enum-values to the user.
IsNullable isNullable bool Should the controls that support it allow setting a value to null or not. false
BorderOptions borderOptions BorderOptions The options for the border. Default values for the class
ExpanderOptions expanderOptions ExpanderOptions The options for the expander. Default values for the class
ByteSizeText byteSizeText string What should the text around where the number of bytes in selected file be. {0} inserts the bytes in readdable size. Selected item has size: {0}
FilenameText filenameText string What should the text around the filename be. {0} inserts the filename. Filename: {0}
PreviewOfThisContentNotAvailableText previewContentNotAvailableText string What should the text to display when preview of byte-content is not available be. Preview of this content not available.
NoBytesSelectedText noBytesSelectedText string What should the text be when no file are selected. No file selected.
MaxFileSizeErrorText maxFileSizeErrorText string What should the text be when the file to be selected was bigger than MaxFileSize. {0} inserts the filename. {1} inserts the size of the file formatted in a readable size. {2} inserts the MaxFileSize in a readdable size. File "{0}" has size {1}. But we only allows files up to {2}.
SetToNullButtonText setToNullButtonText string The text to display on the button to set a value to null. The button is used on some controls, when isNullable is set, that do not handle setting a value to null another way. Set to null
ValueCanNotBeConvertedToStringText valueCanNotBeConvertedToStringText string The text to use as a replacement for value, if it is not possible to convert the value to string. This is for instance used on the aria-helptext if the given value can not be converted to string. Value is not easy to read as a single string.
IEnumerableSingleItemName iEnumerableSingleItemName string What will the name used on each item shown on an IEnumerable. Mark that based on other parameters, the name will not always be shown, but it will also be used as Aria-labels to identify each item. Use {0} to get the parameter name on the IEnumerable, and {1} to get the item number. {0} {1}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.1 88 10/26/2024
1.0.0 95 10/20/2024

- Fixed a small bug that made the program to crash if iEnumerableSingleItemName was used as AdditionalInfo.