C# Class SimpleFramework.Xml.Stream.HyphenStyle

The HyphenStyle is used to represent an XML style that can be applied to a serialized object. A style can be used to modify the element and attribute names for the generated document. This styles can be used to generate hyphenated XML. <example-element> <child-element example-attribute='example'> <inner-element>example</inner-element> </child-element> </example-element> Above the hyphenated XML elements and attributes can be generated from a style implementation. Styles enable the same objects to be serialized in different ways, generating different styles of XML without having to modify the class schema for that object.

Inheritance: Style

显示文件 Open project: ngallagher/simplexml Class Usage Examples

Public Methods

Method	Description
GetAttribute ( String name ) : String	This is used to generate the XML attribute representation of the specified name. Attribute names should ensure to keep the uniqueness of the name such that two different names will be styled in to two different strings.
GetElement ( String name ) : String
HyphenStyle ( ) : System	Constructor for the `HyphenStyle` object. This is used to create a style that will hyphenate XML attributes and elements allowing a consistent format for generated XML.
SetAttribute ( String name, String value ) : void	This is used to set the attribute values within this builder. Overriding the attribute values ensures that the default algorithm does not need to determine each of the values. It allows special behaviour that the user may require for XML.
SetElement ( String name, String value ) : void	This is used to set the element values within this builder. Overriding the element values ensures that the default algorithm does not need to determine each of the values. It allows special behaviour that the user may require for XML.

Method Details

GetAttribute() public method

This is used to generate the XML attribute representation of the specified name. Attribute names should ensure to keep the uniqueness of the name such that two different names will be styled in to two different strings.

public GetAttribute ( String name ) : String
name	String	/// this is the attribute name that is to be styled ///
return	String

GetElement() public method

public GetElement ( String name ) : String
name	String	/// this is the element name that is to be styled ///
return	String

HyphenStyle() public method

Constructor for the HyphenStyle object. This is used to create a style that will hyphenate XML attributes and elements allowing a consistent format for generated XML.

public HyphenStyle ( ) : System
return	System

SetAttribute() public method

This is used to set the attribute values within this builder. Overriding the attribute values ensures that the default algorithm does not need to determine each of the values. It allows special behaviour that the user may require for XML.

public SetAttribute ( String name, String value ) : void
name	String	/// the name of the XML attribute to be overridden ///
value	String	/// the value that is to be used for that attribute ///
return	void

SetElement() public method

This is used to set the element values within this builder. Overriding the element values ensures that the default algorithm does not need to determine each of the values. It allows special behaviour that the user may require for XML.

public SetElement ( String name, String value ) : void
name	String	/// the name of the XML element to be overridden ///
value	String	/// the value that is to be used for that element ///
return	void