A small, yet powerful framework designed for Xaml platforms, Caliburn.Micro implements a variety of UI patterns for solving real-world problems. Patterns that are highlighted include MVVM (Presentation Model), MVP and MVC.
$ dotnet add package Caliburn.Micro.Core<a name='assembly'></a>
<a name='T-Caliburn-Micro-AssemblySource'></a>
typeCaliburn.Micro
A source of assemblies that are inspectable by the framework.
<a name='F-Caliburn-Micro-AssemblySource-FindTypeByNames'></a>
constantsFinds a type which matches one of the elements in the sequence of names.
<a name='F-Caliburn-Micro-AssemblySource-Instance'></a>
constantsThe singleton instance of the AssemblySource used by the framework.
<a name='M-Caliburn-Micro-AssemblySource-AddRange-System-Collections-Generic-IEnumerable{System-Reflection-Assembly}-'></a>
methodAdds a collection of assemblies to AssemblySource
| Name | Type | Description |
|---|---|---|
| assemblies | System.Collections.Generic.IEnumerable{System.Reflection.Assembly} | The assemblies to add |
<a name='T-Caliburn-Micro-AssemblySourceCache'></a>
typeCaliburn.Micro
A caching subsystem for AssemblySource.
<a name='F-Caliburn-Micro-AssemblySourceCache-ExtractTypes'></a>
constantsExtracts the types from the spezified assembly for storing in the cache.
<a name='F-Caliburn-Micro-AssemblySourceCache-Install'></a>
constantsInstalls the caching subsystem.
<a name='T-Caliburn-Micro-ExtensionMethods'></a>
typeCaliburn.Micro
Generic extension methods used by the framework.
<a name='M-Caliburn-Micro-ExtensionMethods-GetAssemblyName-System-Reflection-Assembly-'></a>
methodGet's the name of the assembly.
The assembly's name.
| Name | Type | Description |
|---|---|---|
| assembly | System.Reflection.Assembly | The assembly. |
<a name='M-Caliburn-Micro-ExtensionMethods-GetValueOrDefault``2-System-Collections-Generic-IDictionary{``0,``1},``0-'></a>
methodGets the value for a key. If the key does not exist, return default(TValue);
The key value. default(TValue) if this key is not in the dictionary.
| Name | Type | Description |
|---|---|---|
| dictionary | System.Collections.Generic.IDictionary{``0,``1} | The dictionary to call this method on. |
| key | ``0 | The key to look up. |
| Name | Description |
|---|---|
| TKey | The type of the keys in the dictionary. |
| TValue | The type of the values in the dictionary. |
<a name='T-Caliburn-Micro-NameTransformer'></a>
typeCaliburn.Micro
Class for managing the list of rules for doing name transformation.
<a name='P-Caliburn-Micro-NameTransformer-UseEagerRuleSelection'></a>
propertyFlag to indicate if transformations from all matched rules are returned. Otherwise, transformations from only the first matched rule are returned.
<a name='M-Caliburn-Micro-NameTransformer-AddRule-System-String,System-String,System-String-'></a>
methodAdds a transform using a single replacement value and a global filter pattern.
| Name | Type | Description |
|---|---|---|
| replacePattern | System.String | Regular expression pattern for replacing text |
| replaceValue | System.String | The replacement value. |
| globalFilterPattern | System.String | Regular expression pattern for global filtering |
<a name='M-Caliburn-Micro-NameTransformer-AddRule-System-String,System-Collections-Generic-IEnumerable{System-String},System-String-'></a>
methodAdds a transform using a list of replacement values and a global filter pattern.
| Name | Type | Description |
|---|---|---|
| replacePattern | System.String | Regular expression pattern for replacing text |
| replaceValueList | System.Collections.Generic.IEnumerable{System.String} | The list of replacement values |
| globalFilterPattern | System.String | Regular expression pattern for global filtering |
<a name='M-Caliburn-Micro-NameTransformer-Transform-System-String-'></a>
methodGets the list of transformations for a given name.
The transformed names.
| Name | Type | Description |
|---|---|---|
| source | System.String | The name to transform into the resolved name list |
<a name='M-Caliburn-Micro-NameTransformer-Transform-System-String,System-Func{System-String,System-String}-'></a>
methodGets the list of transformations for a given name.
The transformed names.
| Name | Type | Description |
|---|---|---|
| source | System.String | The name to transform into the resolved name list |
| getReplaceString | System.Func{System.String,System.String} | A function to do a transform on each item in the ReplaceValueList prior to applying the regular expression transform |
<a name='T-Caliburn-Micro-RegExHelper'></a>
typeCaliburn.Micro
Helper class for encoding strings to regular expression patterns
<a name='F-Caliburn-Micro-RegExHelper-NameRegEx'></a>
constantsRegular expression pattern for valid name
<a name='F-Caliburn-Micro-RegExHelper-NamespaceRegEx'></a>
constantsRegular expression pattern for namespace or namespace fragment
<a name='F-Caliburn-Micro-RegExHelper-SubNamespaceRegEx'></a>
constantsRegular expression pattern for subnamespace (including dot)
<a name='M-Caliburn-Micro-RegExHelper-GetCaptureGroup-System-String,System-String-'></a>
methodCreates a named capture group with the specified regular expression
Regular expression capture group with the specified group name
| Name | Type | Description |
|---|---|---|
| groupName | System.String | Name of capture group to create |
| regEx | System.String | Regular expression pattern to capture |
<a name='M-Caliburn-Micro-RegExHelper-GetNameCaptureGroup-System-String-'></a>
methodCreates a capture group for a valid name regular expression pattern
Regular expression capture group with the specified group name
| Name | Type | Description |
|---|---|---|
| groupName | System.String | Name of capture group to create |
<a name='M-Caliburn-Micro-RegExHelper-GetNamespaceCaptureGroup-System-String-'></a>
methodCreates a capture group for a namespace regular expression pattern
Regular expression capture group with the specified group name
| Name | Type | Description |
|---|---|---|
| groupName | System.String | Name of capture group to create |
<a name='M-Caliburn-Micro-RegExHelper-NamespaceToRegEx-System-String-'></a>
methodConverts a namespace (including wildcards) to a regular expression string
Namespace converted to a regular expression
| Name | Type | Description |
|---|---|---|
| srcNamespace | System.String | Source namespace to convert to regular expression |
<a name='T-Caliburn-Micro-NameTransformer-Rule'></a>
typeCaliburn.Micro.NameTransformer
A rule that describes a name transform.
<a name='F-Caliburn-Micro-NameTransformer-Rule-GlobalFilterPattern'></a>
constantsRegular expression pattern for global filtering
<a name='F-Caliburn-Micro-NameTransformer-Rule-ReplacePattern'></a>
constantsRegular expression pattern for replacing text
<a name='F-Caliburn-Micro-NameTransformer-Rule-ReplacementValues'></a>
constantsThe list of replacement values
<a name='P-Caliburn-Micro-NameTransformer-Rule-GlobalFilterPatternRegex'></a>
propertyRegular expression for global filtering
<a name='P-Caliburn-Micro-NameTransformer-Rule-ReplacePatternRegex'></a>
propertyRegular expression for replacing text
<a name='T-Caliburn-Micro-StringSplitter'></a>
typeCaliburn.Micro
Helper class when splitting strings
<a name='M-Caliburn-Micro-StringSplitter-Split-System-String,System-Char-'></a>
methodSplits a string with a chosen separator. If a substring is contained in [...] it will not be splitted.
| Name | Type | Description |
|---|---|---|
| message | System.String | The message to split |
| separator | System.Char | The separator to use when splitting |
<a name='M-Caliburn-Micro-StringSplitter-SplitParameters-System-String-'></a>
methodSplits a string with , as separator. Does not split within {},[],()
| Name | Type | Description |
|---|---|---|
| parameters | System.String | The string to split |
<a name='T-Caliburn-Micro-TypeMappingConfiguration'></a>
typeCaliburn.Micro
Class to specify settings for configuring type mappings by the ViewLocator or ViewModelLocator
<a name='P-Caliburn-Micro-TypeMappingConfiguration-DefaultSubNamespaceForViewModels'></a>
propertyThe default subnamespace for ViewModels. Used for creating default subnamespace mappings. Defaults to "ViewModels".
<a name='P-Caliburn-Micro-TypeMappingConfiguration-DefaultSubNamespaceForViews'></a>
propertyThe default subnamespace for Views. Used for creating default subnamespace mappings. Defaults to "Views".
<a name='P-Caliburn-Micro-TypeMappingConfiguration-IncludeViewSuffixInViewModelNames'></a>
propertyFlag to indicate if ViewModel names should include View suffixes (i.e. CustomerPageViewModel vs. CustomerViewModel)
<a name='P-Caliburn-Micro-TypeMappingConfiguration-NameFormat'></a>
propertyThe format string used to compose the name of a type from base name and name suffix
<a name='P-Caliburn-Micro-TypeMappingConfiguration-UseNameSuffixesInMappings'></a>
propertyFlag to indicate whether or not the name of the Type should be transformed when adding a type mapping. Defaults to true.
<a name='P-Caliburn-Micro-TypeMappingConfiguration-ViewModelSuffix'></a>
propertyThe name suffix for ViewModels. Applies only when UseNameSuffixesInMappings = true. The default is "ViewModel".
<a name='P-Caliburn-Micro-TypeMappingConfiguration-ViewSuffixList'></a>
propertyList of View suffixes for which default type mappings should be created. Applies only when UseNameSuffixesInMappings = true. Default values are "View", "Page"