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

This configuration class represents a participant in a messaging transaction (either sender or recipient). The name provides a way to indicate a common name, the address is a protocol-specific value used in the context of a reference to a given message handler. More...

Inheritance diagram for Apac.Configuration.MessagingGroupElement:

Public Member Functions

System.Xml.Schema.XmlSchema GetSchema ()
 
void ReadXml (System.Xml.XmlReader reader)
 Deserializes the object from XML. More...
 
void WriteXml (System.Xml.XmlWriter writer)
 Serializes the object to XML. More...
 

Protected Member Functions

override void DeserializeElement (System.Xml.XmlReader reader, bool serializeCollectionKey)
 Reads XML from the configuration file. More...
 

Properties

override ConfigurationPropertyCollection Properties [get]
 Gets the collection of configuration properties for this configuration element. More...
 
string Name [get, set]
 Gets or sets the display name for this address. More...
 
MessagingAddressElements Addresses [get, set]
 Gets or sets the (protocol-specific) addresses for the group. More...
 
MessagingAddressRefElements AddressRefs [get, set]
 Gets or sets the address refs. More...
 

Detailed Description

This configuration class represents a participant in a messaging transaction (either sender or recipient). The name provides a way to indicate a common name, the address is a protocol-specific value used in the context of a reference to a given message handler.

Member Function Documentation

◆ DeserializeElement()

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

Reads XML from the configuration file.

Parameters
readerThe T:System.Xml.XmlReader that reads from the configuration file.
serializeCollectionKeytrue to serialize only the collection key properties; otherwise, false.
Exceptions
System.Configuration.ConfigurationErrorsExceptionMessagingGroup must contain an address or addressRefs element.

◆ ReadXml()

void Apac.Configuration.MessagingGroupElement.ReadXml ( System.Xml.XmlReader  reader)
inline

Deserializes the object from XML.

Parameters
readerThe object from which the data is read.

◆ WriteXml()

void Apac.Configuration.MessagingGroupElement.WriteXml ( System.Xml.XmlWriter  writer)
inline

Serializes the object to XML.

Parameters
writerThe object to which the data is written.

Property Documentation

◆ Addresses

MessagingAddressElements Apac.Configuration.MessagingGroupElement.Addresses
getset

Gets or sets the (protocol-specific) addresses for the group.

◆ AddressRefs

MessagingAddressRefElements Apac.Configuration.MessagingGroupElement.AddressRefs
getset

Gets or sets the address refs.

The address refs.

◆ Name

string Apac.Configuration.MessagingGroupElement.Name
getset

Gets or sets the display name for this address.

◆ Properties

override ConfigurationPropertyCollection Apac.Configuration.MessagingGroupElement.Properties
getprotected

Gets the collection of configuration properties for this configuration element.


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