class ConfigValueBrowser in Tinman.AddOns.Application

Abstract base for classes that can browse a ConfigValue by creating an interactive IApplication for it.

abstract class

ConfigValueBrowser

implements

IPleaseIncludeInBinaryThanks

Public / Attributes

All

Returns all currently registered ConfigValueBrowser objects.

public static property	All { get }
type	ConfigValueBrowser[]
value	[not-null]	The list of registered browser objects.

Name

Human-readable name of this ConfigValueBrowser instance.

public abstract property	Name { get }
type	string
value	[not-empty]	The human-readable name.

Public / Methods

Browse

Creates a new instance of IApplication that browses the given config value.

[OwnerReturn]
public abstract method	Browse (ConfigValue config, Validator validator = null)
type	IApplication
params	config	[not-null]	The config value.
	validator		Optional validator object to use for validating the configured native object, before wrapping it in an application.
returns			The browser application or null.

See also:

CanBrowse

CanBrowse

Can this ConfigValueBrowser object create a browser application for the given config value?

public abstract method	CanBrowse (ConfigValue config)
type	bool
params	config	[not-null]	The config value.
returns			true if Browse can possibly create a browser application, false if not (i.e. Browse will always return null).

CanInspect

Can this ConfigValueBrowser object inspect the given config value?

public abstract method	CanInspect (ConfigValue config)
type	bool
params	config	[not-null]	The config value.
returns			true if Inspect can possibly inspect the value, false if not (i.e. Inspect will always return null).

Inspect

Returns an inspection object for the given config value.

[OwnerReturn]
public abstract method	Inspect (ConfigValue config)
type	object
params	config	[not-null]	The config value.
returns			The object that represents the inspection result, or null. Depending on the type of the returned object, the following behaviour applies: IDisposable: The calling code is responsible for calling Dispose. IConfigurable: The ToConfig method can be used to obtain the config value to use as the inspection result. ConfigValue: The returned config value is used as the inspection result.

See also:

CanInspect

PleaseIncludeInBinaryThanks

This is a no-op method that forces the compiler / linker to include this type in the resulting binary.

public method	PleaseIncludeInBinaryThanks ()
implements	IPleaseIncludeInBinaryThanks.PleaseIncludeInBinaryThanks

Remarks:

Calling this stub method makes sure that all lazy constructor calls have been made.

To initialize everything, an application needs to call this method on its root module(s) (see TinmanModule), followed by a call to PleaseIncludeInBinaryThanksAll.

Protected / Methods

Register

Registers this ConfigValueBrowser so that it appears in All.

protected method

Register ()