Implements a non-declarative configuration element base class for use in all configuration elements. More...

Inheritance diagram for Apac.Configuration.ConfigElement:

Public Member Functions
	ConfigElement ()
	Initializes a new instance of the ConfigElement class. More...

	ConfigElement (string name, string description, bool enabled)
	Initializes a new instance of the ConfigElement class. More...

override int	GetHashCode ()
	Returns a hash code for this instance. More...

override bool	Equals (object compareTo)
	Determines whether the specified System.Object is equal to this instance. More...

System.Xml.Schema.XmlSchema	GetSchema ()
	This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the T:System.Xml.Serialization.XmlSchemaProviderAttribute to the class. More...

void	ReadXml (System.Xml.XmlReader reader)
	Generates an object from its XML representation. More...

void	WriteXml (System.Xml.XmlWriter writer)
	Converts an object into its XML representation. More...

Protected Member Functions
virtual void	OnReadXml (System.Xml.XmlReader reader)
	Called when deserializing via XML. More...

virtual void	OnWriteXml (System.Xml.XmlWriter writer)
	Called when serializing via XML. More...

Properties
virtual bool	IsValid `[get]`
	Gives a way for subclasses to determine validity. More...

string	Name `[get, set]`
	Gets or sets the name property setting. More...

string	Description `[get, set]`
	Gets or sets the description property setting. More...

bool	Enabled `[get, set]`
	Gets or sets a value indicating whether this ConfigElement is enabled. More...

log4net.ILog	Log `[get]`
	Provides a log4net.ILog instance for use by the whole class hierarchy. More...

Detailed Description

Implements a non-declarative configuration element base class for use in all configuration elements.

Constructor & Destructor Documentation

◆ ConfigElement() [1/2]

Apac.Configuration.ConfigElement.ConfigElement ( )

inline

Initializes a new instance of the ConfigElement class.

◆ ConfigElement() [2/2]

Apac.Configuration.ConfigElement.ConfigElement	(	string	name,
		string	description,
		bool	enabled
	)

inline

Initializes a new instance of the ConfigElement class.

Parameters

name	The name.
description	The description.
enabled	The enabled flag.

Member Function Documentation

◆ Equals()

override bool Apac.Configuration.ConfigElement.Equals ( object compareTo )

inline

Determines whether the specified System.Object is equal to this instance.

Parameters

compareTo The System.Object to compare with this instance.

Returns: true if the specified System.Object is equal to this instance; otherwise, false.

◆ GetHashCode()

override int Apac.Configuration.ConfigElement.GetHashCode ( )

inline

Returns a hash code for this instance.

Returns: A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

◆ GetSchema()

System.Xml.Schema.XmlSchema Apac.Configuration.ConfigElement.GetSchema ( )

inline

This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the T:System.Xml.Serialization.XmlSchemaProviderAttribute to the class.

Returns: An T:System.Xml.Schema.XmlSchema that describes the XML representation of the object that is produced by the M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter) method and consumed by the M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader) method.

◆ OnReadXml()

virtual void Apac.Configuration.ConfigElement.OnReadXml ( System.Xml.XmlReader reader )

inlineprotectedvirtual

Called when deserializing via XML.

Parameters

reader The reader.

◆ OnWriteXml()

virtual void Apac.Configuration.ConfigElement.OnWriteXml ( System.Xml.XmlWriter writer )

inlineprotectedvirtual

Called when serializing via XML.

Parameters

writer The writer.

◆ ReadXml()

void Apac.Configuration.ConfigElement.ReadXml ( System.Xml.XmlReader reader )

inline

Generates an object from its XML representation.

Parameters

reader The T:System.Xml.XmlReader stream from which the object is deserialized.

◆ WriteXml()

void Apac.Configuration.ConfigElement.WriteXml ( System.Xml.XmlWriter writer )

inline

Converts an object into its XML representation.

Parameters

writer The T:System.Xml.XmlWriter stream to which the object is serialized.

Property Documentation

◆ Description

string Apac.Configuration.ConfigElement.Description

getset

Gets or sets the description property setting.

◆ Enabled

bool Apac.Configuration.ConfigElement.Enabled

getset

Gets or sets a value indicating whether this ConfigElement is enabled.

true if enabled; otherwise, false.

◆ IsValid

virtual bool Apac.Configuration.ConfigElement.IsValid

get

Gives a way for subclasses to determine validity.

◆ Log

log4net.ILog Apac.Configuration.ConfigElement.Log

getprotected

Provides a log4net.ILog instance for use by the whole class hierarchy.

This property is initialized lazily; upon the first access the LogManager will be used to get the logger.

◆ Name

string Apac.Configuration.ConfigElement.Name

getset

Gets or sets the name property setting.

The documentation for this class was generated from the following file:

/var/lib/jenkins/workspace/apac/APAC/APACCore/Configuration/ConfigElement.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ConfigElement() [1/2]

◆ ConfigElement() [2/2]

Member Function Documentation

◆ Equals()

◆ GetHashCode()

◆ GetSchema()

◆ OnReadXml()

◆ OnWriteXml()

◆ ReadXml()

◆ WriteXml()

Property Documentation

◆ Description

◆ Enabled

◆ IsValid

◆ Log

◆ Name