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

Class for creating a host information tag. More...

Inherits PreEmptive.Analytics.Common.Tags.Tag.

Public Member Functions

 OSTag (OSInfo osInfo, bool omitPII)
 Constructor for creating an OS information tag. 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...
 
virtual string ToString (IAttributeLimiter limits)
 Converts the Tag object to an XML string. 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...
 

Properties

override string TagName [get]
 Name of the OS information tag. More...
 
OSInfo OSInfo [get, set]
 An instance of OSInfo that is used to populate the 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...
 
- Protected Member Functions inherited from PreEmptive.Analytics.Common.Tags.Tag
virtual void AppendSerializedInnerTags (StringBuilder sb, IAttributeLimiter limits)
 Will serialize the inner tags and return them as a string More...
 
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...
 
- 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

Class for creating a host information tag.

Constructor & Destructor Documentation

PreEmptive.Analytics.Common.Tags.OSTag.OSTag ( OSInfo  osInfo,
bool  omitPII 
)

Constructor for creating an OS information tag.

Parameters
osInfoAn instance of OSInfo that is used to populate the tag.
omitPIIDetermines if personally identifiable information should be excluded from the tag.

Property Documentation

OSInfo PreEmptive.Analytics.Common.Tags.OSTag.OSInfo
getset

An instance of OSInfo that is used to populate the tag.

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

Name of the OS information tag.


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