TXMLConfigStorage class

In unit XMLPropStorage

Implements a configuration storage mechanism using XML-tagged content.

Declaration

pascal

TXMLConfigStorage = class(TConfigStorage)

Inheritance

TXMLConfigStorage
TConfigStorage

Description

TXMLConfigStorage is a TConfigStorage descendant which implements an XML-storage mechanism for configuration or other values.

TXMLConfigStorage allows names (paths) and values to be accessed using an XPATH-like syntax.

It provides implementations of the abstract virtual methods defined in the ancestor class. It provides overridden constructors that allow the class instance to be created for a qualified file name, a TXMLConfig instance, a subset of values in a TXMLConfig instance, or a stream. Internally, it use TXMLConfig as the storage for values in the class instance.

Use the XMLConfig property to access the internal storage for class instance. Use the overridden methods to read, write, or delete the names and values in the class instance. For example:

DeleteFullPathValue
GetFullPathValue
SetDeleteFullPathValue
SetFullPathValue

Properties

`XMLConfig`	public	TXMLConfig with the values accessed and maintained in the class instance.
`FreeXMLConfig`	public	Indicates whether the TXMLConfig instance is freed when the class is destroyed.

Methods

`GetFullPathValue`	protected	Gets the String value stored at the specified path in the XML storage.
`SetFullPathValue`	protected	Sets the value for the specified path.
`SetDeleteFullPathValue`	protected	Sets the value for or deletes the XML node at the specified path.
`DeleteFullPath`	protected	Deletes the XML node and its content and the specified path.
`DeleteFullPathValue`	protected	Deletes the value stored in the XML node at the specified path.
`Clear`	public	Removes all XML nodes stored in the XMLConfig storage.
`Create`	public	Constructor for the class instance.
`Destroy`	public	Destructor for the class instance.
`WriteToDisk`	public	Stores the values in XMLConfig to the specified file name.
`GetFilename`	public	Gets the file name passed as an argument to the constructor.
`SaveToStream`	public	Saves the content in XMLConfig to the specified TStream instance.

Inherited

From TConfigStorage (13)

AppendBasePath CurrentBasePath DeletePath DeleteValue ExtendPath GetValue ReadObject ReadProperty SetDeleteValue SetValue UndoAppendBasePath WriteObject WriteProperty

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.