CSXmlParser Class

Content Studio 5.7 SDK

Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

This class facilitates the usage of the Content Studio parameters Xml. Callers can parse an existing ParametersXml document and return individual named parameter values. It is also possible to create a new ParametersXml document, add or remove named parameters to it and return it as in its string format using one of the overloaded ToString() methods. Parameter names are case-insensitive and is stored internally as lower case something that is reveled when you read the content as xml.

Inheritance Hierarchy

SystemObject
ContentStudioCSXmlParser

Namespace: ContentStudio
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

Copy

[SerializableAttribute]
public class CSXmlParser : IEnumerable<KeyValuePair<string, string>>, 
	IEnumerable

<SerializableAttribute>
Public Class CSXmlParser
	Implements IEnumerable(Of KeyValuePair(Of String, String)), 
	IEnumerable

The CSXmlParser type exposes the following members.

Constructors

	Name	Description
	CSXmlParser	Creates a new CSXmlParser.
	CSXmlParser(Stream)	Creates a new CSXmlParser from a Stream that contains the data to load.
	CSXmlParser(String)	Creates a new CSXmlParser
	CSXmlParser(XmlReader)	Creates a new CSXmlParser from an XmlReader
	CSXmlParser(String, Encoding)	Creates a new CSXmlParser

Top

Properties

	Name	Description
	Count	Returns the number of parameters in the object.
	ItemInt32	Sets or gets the value of a parameter
	ItemString	Sets or gets the value of a parameter

Top

Methods

	Name	Description
	Add(String)	Adds a new named parameter.
	Add(String, String)	Adds a new named parameter.
	Clear	Removes all parameters.
	Contains	Checks whether a certain parameter exists
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetHashCode	(Inherited from Object.)
	GetParameter(String)	Gets the value of a parameter as a string
	GetParameter(String, String)	Gets the value of a parameter
	GetParameterAsBoolean(String)	Returns a parameter as an integer. The value must be possible to convert to boolean. Valid value pairs are true/false, 1/0, yes/no or on/off.
	GetParameterAsBoolean(String, Boolean)	Returns a parameter as an integer. The value must be possible to convert to boolean. Valid value pairs are true/false, 1/0, yes/no or on/off.
	GetParameterAsBooleanArray	Returns an array of Boolean values that are stored as a separated value strings in the parameter.
	GetParameterAsCSFileObjectType(String)	Returns a parameter as a CSFileObjectTypes enumeration. The value must be possible to convert to this data type from its string representation.
	GetParameterAsCSFileObjectType(String, CSFileObjectTypes)	Returns a parameter as a CSFileObjectTypes enumeration. The value must be possible to convert to this data type from its string representation.
	GetParameterAsCSSecurableObjects(String)	Returns a parameter as a CSSecurableObjects type
	GetParameterAsCSSecurableObjects(String, CSSecurableObjects)	Returns a parameter as a CSSecurableObjects type
	GetParameterAsDateTime(String)	Returns a parameter as a DateTime. The value must be possible to convert to a DateTime.
	GetParameterAsDateTime(String, DateTime)	Returns a parameter as a DateTime. The value must be possible to convert to a DateTime.
	GetParameterAsDateTimeArray	Returns an array of strings that are stored as a separated value strings in the parameter.
	GetParameterAsInt32(String)	Returns a parameter as an integer. The value must be possible to convert to an integer.
	GetParameterAsInt32(String, Int32)	Returns a parameter as an integer. The value must be possible to convert to an integer.
	GetParameterAsInt32Array	Returns an array of Int32 values that are stored as a separated value strings in the parameter.
	GetParameterAsStringArray	Returns an array of strings that are stored as a separator separated value string in the parameter.
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	Remove	Removes a named parameter.
	ToString	Returns the CSXml represented by the object as as string. Parameters with null values are omitted. (Overrides ObjectToString.)
	ToString(Encoding)	Returns the CSXml represented by the object as as string. Parameters with null values are omitted.

Top

Reference

ContentStudio Namespace