PreEmptive Analytics .NET API  1.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Protected Member Functions | Properties | List of all members
PreEmptive.Analytics.Common.Tags.MessagesTag Class Reference

A class for creating a messages tag. More...

Inherits PreEmptive.Analytics.Common.Tags.Tag.

Public Member Functions

 MessagesTag (Configuration configuration, AgentInfo agentInfo, IEnumerable< Message > messages)
 Constructor for creating a messages tag. More...
 
override string ToString (IAttributeLimiter limits)
 Converts the current message tag to a string. This also applies some size estimations to the StringBuffer used so that it avoids Large Object Heap fragmentation when possible More...
 
- Public Member Functions inherited from PreEmptive.Analytics.Common.Tags.Tag
 Tag ()
 Constructor for creating a Tag. More...
 
 Tag (string tagName)
 Constructor for creating a Tag. More...
 
override string ToString ()
 Converts the Tag object to an XML string. More...
 
virtual void AppendToStringBuilder (StringBuilder sb, IAttributeLimiter limits)
 Serializes the tag to a string appending directly onto the passed in StringBuilder More...
 
void AddAttribute (string name, string value)
 Adds an attribute to the current Tag. More...
 
void AddOptionalAttribute (string name, string value)
 Adds an optional attribute to the current Tag. If the value provided is null, then the attribute will not be added. More...
 

Protected Member Functions

override void AppendSerializedInnerTags (StringBuilder sb, IAttributeLimiter limits)
 Convert all of the object represenations of inner tags for this messages to strings. More...
 
- Protected Member Functions inherited from PreEmptive.Analytics.Common.Tags.Tag
string Escape (string s, int?maxLength=null)
 Escapes characters from the given string More...
 
void AddOptionalAttribute< T > (string name, T value)
 Add an optional attribute to the current tag. If the value provided is null, then the attribute will not be added. More...
 

Properties

override string TagName [get]
 Name of the messages tag. More...
 
- Properties inherited from PreEmptive.Analytics.Common.Tags.Tag
virtual string TagName [get]
 The name of the tag. More...
 
virtual string TagDescription [get]
 A more descriptive tag name. More...
 
List< TagInnerTags [get, set]
 A list of tags that are nested within this tag. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from PreEmptive.Analytics.Common.Tags.Tag
static Tag FromString (string str)
 Creates a Tag object from an XML string. More...
 
static Tag FromReader (TextReader reader)
 Creates (deserializes) a Tag object from an XML string provided by a TextReader More...
 
- Public Attributes inherited from PreEmptive.Analytics.Common.Tags.Tag
AttributeList Attributes = new AttributeList()
 The list of attributes that will be added to the Tag. More...
 
- Static Protected Member Functions inherited from PreEmptive.Analytics.Common.Tags.Tag
static void AppendEscape (StringBuilder sb, string s, int?maxLength=null)
 Esxapes the characters in the given string and appends the escaped text to the provided StringBuilder More...
 

Detailed Description

A class for creating a messages tag.

Constructor & Destructor Documentation

PreEmptive.Analytics.Common.Tags.MessagesTag.MessagesTag ( Configuration  configuration,
AgentInfo  agentInfo,
IEnumerable< Message messages 
)

Constructor for creating a messages tag.

Parameters
configurationA Configuration object that is used to fill the inner tag of the messages tag.
agentInfoAn AgentInfo object that is used to fill the inner tag of the messages tag.
messagesA collection of Messages that are to be contained within the messages tag.

Member Function Documentation

override void PreEmptive.Analytics.Common.Tags.MessagesTag.AppendSerializedInnerTags ( StringBuilder  sb,
IAttributeLimiter  limits 
)
protectedvirtual

Convert all of the object represenations of inner tags for this messages to strings.

Returns
The string representation of the inner tags.

Reimplemented from PreEmptive.Analytics.Common.Tags.Tag.

override string PreEmptive.Analytics.Common.Tags.MessagesTag.ToString ( IAttributeLimiter  limits)
virtual

Converts the current message tag to a string. This also applies some size estimations to the StringBuffer used so that it avoids Large Object Heap fragmentation when possible

Parameters
limitsThe limiter
Returns
The serialized XML string

Reimplemented from PreEmptive.Analytics.Common.Tags.Tag.

Property Documentation

override string PreEmptive.Analytics.Common.Tags.MessagesTag.TagName
get

Name of the messages tag.


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