C# Class SimpleFramework.Xml.Stream.Format

The Format object is used to provide information on how a generated XML document should be structured. The information provided tells the formatter whether an XML prolog is required and the number of spaces that should be used for indenting. The prolog specified will be written directly before the XML document.

Should a Format be created with an indent of zero or less then no indentation is done, and the generated XML will be on the same line. The prolog can contain any legal XML heading, which can domain a DTD declaration and XML comments if required.

Datei anzeigen Open project: ngallagher/simplexml Class Usage Examples

Public Methods

Method	Description
Format ( ) : System	Constructor for the `Format` object. This creates an object that is used to describe how the formatter should create the XML document. This constructor uses an indent size of three.
Format ( String prolog ) : System	Constructor for the `Format` object. This creates an object that is used to describe how the formatter should create the XML document. This constructor uses the specified prolog that is to be inserted at the start of the XML document.
Format ( Style style ) : System	Constructor for the `Format` object. This creates an object that is used to describe how the formatter should create the XML document. This constructor uses the specified style to style the attributes and elements of the XML document.
Format ( int indent ) : System	Constructor for the `Format` object. This creates an object that is used to describe how the formatter should create the XML document. This constructor uses the specified indent size and a null prolog, which means no prolog is generated.
Format ( int indent, String prolog ) : System	Constructor for the `Format` object. This creates an object that is used to describe how the formatter should create the XML document. This constructor uses the specified indent size and the text to use in the generated prolog.
Format ( int indent, String prolog, Style style ) : System	Constructor for the `Format` object. This creates an object that is used to describe how the formatter should create the XML document. This constructor uses the specified indent size and the text to use in the generated prolog.
Format ( int indent, Style style ) : System	Constructor for the `Format` object. This creates an object that is used to describe how the formatter should create the XML document. This constructor uses the specified indent size and the style provided to style the XML document.

Method Details

Format() public method

Constructor for the Format object. This creates an object that is used to describe how the formatter should create the XML document. This constructor uses an indent size of three.

public Format ( ) : System
return	System

Format() public method

Constructor for the Format object. This creates an object that is used to describe how the formatter should create the XML document. This constructor uses the specified prolog that is to be inserted at the start of the XML document.

public Format ( String prolog ) : System
prolog	String	/// This is the prolog for the generated XML document ///
return	System

Format() public method

Constructor for the Format object. This creates an object that is used to describe how the formatter should create the XML document. This constructor uses the specified style to style the attributes and elements of the XML document.

public Format ( Style style ) : System
style	Style	/// This is the style to apply to the format object. ///
return	System

Format() public method

Constructor for the Format object. This creates an object that is used to describe how the formatter should create the XML document. This constructor uses the specified indent size and a null prolog, which means no prolog is generated.

public Format ( int indent ) : System
indent	int	/// This is the number of spaces used in the indent. ///
return	System

Format() public method

public Format ( int indent, String prolog ) : System
indent	int	/// This is the number of spaces used in the indent. ///
prolog	String	/// This is the prolog for the generated XML document. ///
return	System

Format() public method

public Format ( int indent, String prolog, Style style ) : System
indent	int	/// This is the number of spaces used in the indent. ///
prolog	String	/// This is the prolog for the generated XML document. ///
style	Style	/// This is the style to apply to the format object. ///
return	System

Format() public method

public Format ( int indent, Style style ) : System
indent	int	/// This is the number of spaces used in the indent. ///
style	Style	/// This is the style to apply to the format object. ///
return	System