KeyReplacementsBuilder
public sealed class KeyReplacementsBuilder
Namespace: RhoMicro.BindSight.Transformations
Inheritance:
Summary
Section titled “Summary”Provides key replacements to KeyReplacementTransformation.
Constructors
Section titled “Constructors”KeyReplacementsBuilder(BindSightBuilder)
Section titled “KeyReplacementsBuilder(BindSightBuilder)”public KeyReplacementsBuilder(BindSightBuilder optionsDocs)
Summary
Section titled “Summary”Provides key replacements to KeyReplacementTransformation.
Properties
Section titled “Properties”BindSight
Section titled “BindSight”public BindSightBuilder BindSight { get; }
Summary
Section titled “Summary”Gets the wrapped options docs builder.
Methods
Section titled “Methods”Use(string, string)
Section titled “Use(string, string)”public KeyReplacementsBuilder Use(string key, string replacement)
Summary
Section titled “Summary”Replaces keys prefixed with key with their prefix replaced by replacement.
Parameters
Section titled “Parameters”Name | Type | Description |
---|---|---|
key | String | The key prefix to replace. |
replacement | String | The replacement prefix. |
Returns
Section titled “Returns”A reference to the builder, for chaining of further method calls.
Use<TOptions>(string)
Section titled “Use<TOptions>(string)”public KeyReplacementsBuilder Use<TOptions>(string replacement)
Summary
Section titled “Summary”Replaces keys prefixed with typeof(TOptions).Name
with their prefix replaced by replacement.
Parameters
Section titled “Parameters”Name | Type | Description |
---|---|---|
replacement | String | The replacement prefix. |
Returns
Section titled “Returns”A reference to the builder, for chaining of further method calls.
Clear()
Section titled “Clear()”public KeyReplacementsBuilder Clear()
Summary
Section titled “Summary”Clears out all registered replacements.
Returns
Section titled “Returns”A reference to the builder, for chaining of further method calls.
UseDefaults()
Section titled “UseDefaults()”public KeyReplacementsBuilder UseDefaults()
Summary
Section titled “Summary”Adds default replacements to the builder.
Remarks
Section titled “Remarks”The following replacements will be added:
Returns
Section titled “Returns”A reference to the builder, for chaining of further method calls.