C# Класс ZForge.Configuration.XMLConfig

The class which represents a configuration xml file
Наследование: IDisposable
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
Clean ( ) : void

Strip empty nodes from the whole tree.

Commit ( ) : bool

If loaded from a file, commit any changes, by overwriting the file

Dispose ( ) : void

Save any modifications to the XML file before destruction if CommitOnUnload is true

LoadXmlFromFile ( string filename ) : void

Load a new XmlDocument from a file

Throws an exception if file does not exist

LoadXmlFromFile ( string filename, bool create ) : void

Load a new XmlDocument from a file

LoadXmlFromString ( string xml ) : void

Load a new XmlDocument from a string

NewXml ( string rootelement ) : void

Load an empty XmlDocument

Reload ( ) : bool

If loaded from a file, trash any changes, and reload the file

Save ( System stream ) : void

Save configuration to a stream

Save ( string filename ) : void

Save configuration to an xml file

ValidateXML ( bool silent ) : bool

Check XML file if it conforms the config xml restrictions 1. No nodes with two children of the same name 2. Only alphanumerical names

XMLConfig ( ) : System

Create an XmlConfig from an empty xml file containing only the rootelement named as 'xml'

XMLConfig ( string xml ) : System
XMLConfig ( string loadfromfile, bool create ) : System

Create an XmlConfig from an existing file, or create a new one

Описание методов

Clean() публичный Метод

Strip empty nodes from the whole tree.
public Clean ( ) : void
Результат void

Commit() публичный Метод

If loaded from a file, commit any changes, by overwriting the file
public Commit ( ) : bool
Результат bool

Dispose() публичный Метод

Save any modifications to the XML file before destruction if CommitOnUnload is true
public Dispose ( ) : void
Результат void

LoadXmlFromFile() публичный Метод

Load a new XmlDocument from a file
Throws an exception if file does not exist
public LoadXmlFromFile ( string filename ) : void
filename string /// Path and filename from where to load the xml file ///
Результат void

LoadXmlFromFile() публичный Метод

Load a new XmlDocument from a file
public LoadXmlFromFile ( string filename, bool create ) : void
filename string /// Path and filename from where to load the xml file ///
create bool /// If file does not exist, create it, or throw an exception? ///
Результат void

LoadXmlFromString() публичный Метод

Load a new XmlDocument from a string
public LoadXmlFromString ( string xml ) : void
xml string /// XML string ///
Результат void

NewXml() публичный Метод

Load an empty XmlDocument
public NewXml ( string rootelement ) : void
rootelement string /// Name of root element ///
Результат void

Reload() публичный Метод

If loaded from a file, trash any changes, and reload the file
public Reload ( ) : bool
Результат bool

Save() публичный Метод

Save configuration to a stream
public Save ( System stream ) : void
stream System /// Stream where to save ///
Результат void

Save() публичный Метод

Save configuration to an xml file
public Save ( string filename ) : void
filename string /// Path and filname where to save ///
Результат void

ValidateXML() публичный Метод

Check XML file if it conforms the config xml restrictions 1. No nodes with two children of the same name 2. Only alphanumerical names
public ValidateXML ( bool silent ) : bool
silent bool /// Whether to return a true/false value, or throw an exception on failiure ///
Результат bool

XMLConfig() публичный Метод

Create an XmlConfig from an empty xml file containing only the rootelement named as 'xml'
public XMLConfig ( ) : System
Результат System

XMLConfig() публичный Метод

public XMLConfig ( string xml ) : System
xml string
Результат System

XMLConfig() публичный Метод

Create an XmlConfig from an existing file, or create a new one
public XMLConfig ( string loadfromfile, bool create ) : System
loadfromfile string /// Path and filename from where to load the xml file ///
create bool /// If file does not exist, create it, or throw an exception? ///
Результат System