AP&C API Reference
Public Member Functions | Protected Member Functions | Properties | List of all members
Apac.Configuration.MessageConfigElements Class Reference

Implements a basic configuration map for message configurations. More...

Inheritance diagram for Apac.Configuration.MessageConfigElements:

Public Member Functions

 MessageConfigElements ()
 Default constructor. More...
 

Protected Member Functions

override ConfigurationElement CreateNewElement ()
 Creates a new configuration element during deserialization. More...
 
override object GetElementKey (ConfigurationElement element)
 Gets the unique identifier from element . More...
 
override void DeserializeElement (System.Xml.XmlReader reader, bool serializeCollectionKey)
 Deserializes an element from XML configuration. More...
 

Properties

MessageConfigElement this[int idx] [get, set]
 Numeric indexer that gets or sets the value at the provided index. More...
 
new MessageConfigElement this[string type] [get, set]
 Special indexer for retrieving configs by message type. More...
 
MessageConfigElement this[Messaging.MessageType messageType] [get]
 String indexer (provided for convenience) that gets the value at the provided index. More...
 
override string ElementName [get]
 Gets the name of the XML elements that are contained in this collection. More...
 
override ConfigurationPropertyCollection Properties [get]
 Gets the collection of configuration properties for this configuration element. More...
 
override ConfigurationElementCollectionType CollectionType [get]
 Overrides the default collection type to make this a basic map. More...
 

Detailed Description

Implements a basic configuration map for message configurations.

Constructor & Destructor Documentation

◆ MessageConfigElements()

Apac.Configuration.MessageConfigElements.MessageConfigElements ( )
inline

Default constructor.

Member Function Documentation

◆ CreateNewElement()

override ConfigurationElement Apac.Configuration.MessageConfigElements.CreateNewElement ( )
inlineprotected

Creates a new configuration element during deserialization.

Returns
A new MessageConfigElement.

◆ DeserializeElement()

override void Apac.Configuration.MessageConfigElements.DeserializeElement ( System.Xml.XmlReader  reader,
bool  serializeCollectionKey 
)
inlineprotected

Deserializes an element from XML configuration.

Parameters
readerThe System.Xml.XmlReader containing the serialized data.
serializeCollectionKey??

◆ GetElementKey()

override object Apac.Configuration.MessageConfigElements.GetElementKey ( ConfigurationElement  element)
inlineprotected

Gets the unique identifier from element .

Parameters
elementThe element for which the unique id is needed.
Returns
Returns the MessageConfigElement.MessageType property.

Property Documentation

◆ CollectionType

override ConfigurationElementCollectionType Apac.Configuration.MessageConfigElements.CollectionType
get

Overrides the default collection type to make this a basic map.

◆ ElementName

override string Apac.Configuration.MessageConfigElements.ElementName
getprotected

Gets the name of the XML elements that are contained in this collection.

◆ Properties

override ConfigurationPropertyCollection Apac.Configuration.MessageConfigElements.Properties
getprotected

Gets the collection of configuration properties for this configuration element.

◆ this[int idx]

MessageConfigElement Apac.Configuration.MessageConfigElements.this[int idx]
getset

Numeric indexer that gets or sets the value at the provided index.

Parameters
idxThe numeric index into the collection.
Returns
The MessageConfigElement at the provided index.

◆ this[Messaging.MessageType messageType]

MessageConfigElement Apac.Configuration.MessageConfigElements.this[Messaging.MessageType messageType]
get

String indexer (provided for convenience) that gets the value at the provided index.

Parameters
messageTypeThe message type used to index into the collection.
Returns
The MessageConfigElement at the provided index.

◆ this[string type]

new MessageConfigElement Apac.Configuration.MessageConfigElements.this[string type]
getset

Special indexer for retrieving configs by message type.

Parameters
typeThe type of message to be retrieved.
Returns
The config element or null.

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