 | BenchConfiguration Class |
The merged configuration for a Bench environment.
Inheritance HierarchySystemObject
Mastersign.Bench.PropertyCollectionsPropertyCollection
Mastersign.Bench.PropertyCollectionsResolvingPropertyCollection
Mastersign.BenchBenchConfiguration
Mastersign.Bench.PropertyCollectionsPropertyCollection
Mastersign.Bench.PropertyCollectionsResolvingPropertyCollection
Mastersign.BenchBenchConfiguration
Namespace: Mastersign.Bench
Assembly: BenchLib (in BenchLib.dll) Version: 0.22.0.0 (0.22.0.0)
SyntaxThe BenchConfiguration type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BenchConfiguration(String) |
Initializes a new instance of BenchConfiguration
loading all configuration and app library files.
|
| BenchConfiguration(String, Boolean, Boolean, Boolean) |
Initializes a new instance of BenchConfiguration
loading the specified set of configuration and app library files.
|
Properties| Name | Description | |
|---|---|---|
 | AppLibraries |
The app libraries defined in the configuration property AppLibs.
|
| AppProperties |
The merged definition of the Bench apps.
|
| Apps |
The merged definition of the Bench apps as a AppIndexFacade.
|
| BenchResourceDir |
The absolute path to the Bench resource directory.
|
| BenchRootDir |
The absolute path to the root directory of Bench.
|
| CanTransferAppLibraryCache |
Checks whether the cached app libraries of this Bench environment
can be transfered in case of an export or cloning.
|
| CanTransferAppResourceCache |
Checks whether the cached app resources of this Bench environment
can be transfered in case of an export or cloning.
|
| CanTransferHomeDirectory |
Checks whether the home directory of this Bench environment
can be transfered in case of an export or cloning.
|
| CanTransferProjectDirectory |
Checks whether the project directory of this Bench environment
can be transfered in case of an export or cloning.
|
| DefaultValueSource |
The backup value source for ungrouped properties.
(Inherited from PropertyCollection.) |
| Sources |
Gets an array with absolute paths for all configuration files
used to compile this configuration.
|
| Use64Bit |
Is true if the operating system supports 64Bit code
and the Bench configuration allows 64Bit binaries.
|
| WithAppIndex |
A flag which indicates if the app library was loaded during initialization of the BenchConfiguration.
|
| WithSiteConfiguration |
A flag which indicates if the site configuration was loaded during the initialization of the BenchConfiguration.
|
| WithUserConfiguration |
A flag which indicates if the user configuration was loaded during initialization of the BenchConfiguration.
|
Methods| Name | Description | |
|---|---|---|
| AddResolver |
Registers a number of property resolvers.
(Inherited from ResolvingPropertyCollection.) |
| CanGetValue |
Checks, whether this object can retrieve the value for the specified property, or not.
(Inherited from PropertyCollection.) |
| Clear |
Deletes all properties in this collection.
(Inherited from PropertyCollection.) |
| ContainsValue |
Checks, whether this collection contains the specified property.
(Inherited from PropertyCollection.) |
| CopyBenchInitializationPropertiesFrom |
Copy a couple of temporary properties, needed during the initialization
of a Bench environment, from a source configuration to this configuration.
|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| FindSiteConfigFiles |
Search for all existing site configuration files in the root directory of Bench
and its parents.
|
| GetAppLibrary |
Gets an app library by its ID.
|
| GetBooleanValue(String) |
Gets the value of a property as a boolean.
(Inherited from PropertyCollection.) |
| GetBooleanValue(String, Boolean) |
Gets the value of a property as a boolean, or a default value if the
specified property does not exist or its value can not be properly converted.
(Inherited from PropertyCollection.) |
| GetConfigurationFiles |
Lists the configuration files of the Bench environment.
|
| GetHashCode | (Inherited from Object.) |
| GetInt32Value(String) |
Gets the value of a property as an integer.
(Inherited from PropertyCollection.) |
| GetInt32Value(String, Int32) |
Gets the value of a property as an integer, or a default value if the
specified property does not exist or its value can not be properly converted.
(Inherited from PropertyCollection.) |
| GetRawValue |
Gets the unresolved and untransformed value of a property in this collection,
without looking up the property in DefaultValueSource.
(Inherited from PropertyCollection.) |
| GetStringListValue(String) |
Gets the value of a property as a string array.
(Inherited from PropertyCollection.) |
| GetStringListValue(String, String) |
Gets the value of a property as a string array, or a default value if the
specified property does not exist or its value can not be properly converted.
(Inherited from PropertyCollection.) |
| GetStringValue(String) |
Gets the value of a property as a string.
(Inherited from PropertyCollection.) |
| GetStringValue(String, String) |
Gets the value of a property as a string, or a default value if the
specified property does not exist or its value can not be properly converted.
(Inherited from PropertyCollection.) |
| GetTransferPaths |
Returns an array with relative paths to the directories and files,
relevant for a transfer of the Bench environment.
|
| GetType | (Inherited from Object.) |
| GetValue(String) |
Gets the value of the specified property.
(Inherited from PropertyCollection.) |
| GetValue(String, Object) |
Gets the value of the specified property, or a given default value,
in case the specified property does not exist.
(Inherited from PropertyCollection.) |
 | IsValidBenchRoot |
Checks if the given path is a valid root path of a Bench environment.
|
| MemberwiseClone | (Inherited from Object.) |
| PropertyNames |
Gets the names from all existing properties.
(Inherited from PropertyCollection.) |
| Reload |
Reloads the set of configuration files, specified during construction.
Call this method to create an updated instance of BenchConfiguration
after one of the configuration files was changed.
|
| ResetValue |
Resets the specified property.
(Inherited from PropertyCollection.) |
| ResolveValue |
The implementation of ResolveValue(String, Object),
calling all registered resolvers in the order they were registered.
(Inherited from ResolvingPropertyCollection.) |
| SetValue(String, Boolean) |
Sets a boolean value for the specified property.
(Inherited from PropertyCollection.) |
| SetValue(String, Int32) |
Sets an integer value for the specified property.
(Inherited from PropertyCollection.) |
| SetValue(String, Object) |
Sets the value of the specified property.
If the property did exist until now, it is created.
(Inherited from PropertyCollection.) |
| SetValue(String, String) |
Sets a string value for the specified property.
(Inherited from PropertyCollection.) |
| SetValue(String, String) |
Sets a string array value for the specified property.
(Inherited from PropertyCollection.) |
| ToString |
Returns a string represenation of this property collection.
(Inherited from PropertyCollection.) |
| ToString(Boolean) |
Returns a string represenation of this property collection.
(Inherited from PropertyCollection.) |
Fields| Name | Description | |
|---|---|---|
 | CONFIG_FILE |
The relative path of the Bench configuration file.
|
| MAIN_PS_LIB_FILE |
The relative path of the PowerShell API library file.
|
| ROOT_SCRIPTS_PATTERN |
A search pattern to find all root scripts in the res directory.
|
RemarksThe configuration is merged by loading the following files:
- default - res\config.md
- custom - config\config.md
- site - bench-site.md files (filename can be changed via custom config)
See Also