Craig's Utility Library  4.0 Beta
Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType > Class Template Referenceabstract

Format base class for objects that are string based More...

Inheritance diagram for Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >:
Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, string > Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >

Public Member Functions

override object Clone ()
 Clones the object More...
 
override int CompareTo (FormatType other)
 Compares the object to another object More...
 
override bool Equals (FormatType other)
 Determines if the objects are equal More...
 
override FormatType Save (string Location)
 Saves the object More...
 
- Public Member Functions inherited from Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, string >
int CompareTo (object obj)
 Compares the object to another object More...
 
override bool Equals (object obj)
 Determines if the objects are equal More...
 
override int GetHashCode ()
 Gets the hash code for the object More...
 

Static Public Member Functions

static implicit operator string (StringFormatBase< FormatType > Value)
 Converts the format to a string More...
 
static implicit operator StringFormatBase< FormatType > (string Value)
 Converts the string to the format specified More...
 
- Static Public Member Functions inherited from Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, string >
static FormatType Load (string Location)
 Loads the object from the location specified More...
 
static bool operator!= (FormatBase< FormatType, ContentType > Value1, FormatBase< FormatType, ContentType > Value2)
 Determines if the two are not equal More...
 
static bool operator< (FormatBase< FormatType, ContentType > Value1, FormatBase< FormatType, ContentType > Value2)
 Determines if it is less than More...
 
static bool operator<= (FormatBase< FormatType, ContentType > Value1, FormatBase< FormatType, ContentType > Value2)
 Determines if it is less than or equal More...
 
static bool operator== (FormatBase< FormatType, ContentType > Value1, FormatBase< FormatType, ContentType > Value2)
 Determines if the two are equal More...
 
static bool operator> (FormatBase< FormatType, ContentType > Value1, FormatBase< FormatType, ContentType > Value2)
 Determines if it is greater than More...
 
static bool operator>= (FormatBase< FormatType, ContentType > Value1, FormatBase< FormatType, ContentType > Value2)
 Determines if it is greater than or equal More...
 

Protected Member Functions

 StringFormatBase ()
 Constructor More...
 
override FormatType InternalLoad (string Location)
 Loads the object from the location specified More...
 
abstract void LoadFromData (string Data)
 Loads the object from the data specified More...
 
- Protected Member Functions inherited from Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, string >
 FormatBase ()
 Constructor More...
 

Detailed Description

Format base class for objects that are string based

Type Constraints
FormatType :StringFormatBase<FormatType> 
FormatType :new() 

Definition at line 30 of file StringFormatBase.cs.

Constructor & Destructor Documentation

Constructor

Definition at line 36 of file StringFormatBase.cs.

Member Function Documentation

override object Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >.Clone ( )
virtual

Clones the object

Returns
A newly cloned object

Implements Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, string >.

Definition at line 67 of file StringFormatBase.cs.

override int Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >.CompareTo ( FormatType  other)
virtual

Compares the object to another object

Parameters
otherObject to compare to
Returns
0 if they are equal, -1 if this is smaller, 1 if it is larger

Implements Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, string >.

Definition at line 77 of file StringFormatBase.cs.

override bool Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >.Equals ( FormatType  other)
virtual

Determines if the objects are equal

Parameters
otherOther object to compare to
Returns
True if they are equal, false otherwise

Implements Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, string >.

Definition at line 87 of file StringFormatBase.cs.

override FormatType Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >.InternalLoad ( string  Location)
protectedvirtual

Loads the object from the location specified

Parameters
LocationLocation of the file to load
Returns
This

Implements Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, string >.

Definition at line 108 of file StringFormatBase.cs.

abstract void Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >.LoadFromData ( string  Data)
protectedpure virtual

Loads the object from the data specified

Parameters
DataData to load into the object

Implemented in Utilities.IO.FileFormats.VCard, Utilities.IO.FileFormats.VCalendar, Utilities.IO.FileFormats.RSS.Document, and Utilities.IO.FileFormats.INI.

static implicit Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >.operator string ( StringFormatBase< FormatType >  Value)
static

Converts the format to a string

Parameters
ValueValue to convert
Returns
The value as a string

Definition at line 45 of file StringFormatBase.cs.

static implicit Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >.operator StringFormatBase< FormatType > ( string  Value)
static

Converts the string to the format specified

Parameters
ValueValue to convert
Returns
The string as an object

Definition at line 56 of file StringFormatBase.cs.

override FormatType Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >.Save ( string  Location)
virtual

Saves the object

Parameters
LocationLocation to save it to
Returns
This

Implements Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, string >.

Definition at line 97 of file StringFormatBase.cs.


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