C# Class CCNet.Build.Confluence.PageDocument

Represents confluence page as XML document.

Show file Open project: shuruev/CCNet.Extensions Class Usage Examples

Public Methods

Method	Description
BuildBody ( ) : System.Xml.Linq.XElement	Builds rich text body section.
BuildColumn ( string width, System.Xml.Linq.XElement body ) : System.Xml.Linq.XElement	Builds "Column" macro block.
BuildEmoticon ( string emoticon ) : System.Xml.Linq.XElement	Builds emoticon symbol.
BuildImage ( string imageUrl ) : System.Xml.Linq.XElement	Builds "Image" block.
BuildInfo ( System.Xml.Linq.XElement body ) : System.Xml.Linq.XElement	Builds "Info" macro block.
BuildPageLink ( string pageTitle ) : System.Xml.Linq.XElement	Builds "Page link" block.
BuildPageLink ( string pageTitle, string linkText ) : System.Xml.Linq.XElement	Builds "Page link" block.
BuildPageLink ( string pageTitle, string pageAnchor, string linkText ) : System.Xml.Linq.XElement	Builds "Page link" block.
BuildSection ( System.Xml.Linq.XElement body ) : System.Xml.Linq.XElement	Builds "Section" macro block.
BuildStatus ( string title, StatusColor color, bool outline ) : System.Xml.Linq.XElement	Builds "Status" macro block.
BuildToc ( ) : System.Xml.Linq.XElement	Builds "Table of Contents" macro block.
BuildUserLink ( string userKey ) : System.Xml.Linq.XElement	Builds "User link" block.
DecodeEntities ( string content ) : string	Encodes all HTML entities back to their original representation.
EncodeEntities ( string content ) : string	Encodes all HTML entities to avoid confusions for XML parser.
Nm ( string name ) : System.Xml.Linq.XName	Builds XML name using internal namespace prefixes.
PageDocument ( string content = null ) : System	Initializes a new instance.
Render ( ) : string	Renders page content back to its XML representation.

Private Methods

Method	Description
Attribute ( string name, object value ) : System.Xml.Linq.XAttribute	Builds new attribute, using internal namespace prefixes.
BuildPageLink ( string>.Tuple pageTitleAndAnchor, System.Xml.Linq.XElement linkBody ) : System.Xml.Linq.XElement	Builds "Page link" block.
CheckBody ( System.Xml.Linq.XElement body ) : void	Makes sure specified element is a rich text body section.
Element ( string name ) : System.Xml.Linq.XElement	Builds new element, using internal namespace prefixes.
PageDocument ( ) : System
ParseDocument ( string content ) : System.Xml.Linq.XDocument	Creates XML document for specified page content.

Method Details

BuildBody() public static method

Builds rich text body section.

public static BuildBody ( ) : System.Xml.Linq.XElement
return	System.Xml.Linq.XElement

BuildColumn() public static method

Builds "Column" macro block.

public static BuildColumn ( string width, System.Xml.Linq.XElement body ) : System.Xml.Linq.XElement
width	string
body	System.Xml.Linq.XElement
return	System.Xml.Linq.XElement

BuildEmoticon() public static method

Builds emoticon symbol.

public static BuildEmoticon ( string emoticon ) : System.Xml.Linq.XElement
emoticon	string
return	System.Xml.Linq.XElement

BuildImage() public static method

Builds "Image" block.

public static BuildImage ( string imageUrl ) : System.Xml.Linq.XElement
imageUrl	string
return	System.Xml.Linq.XElement

BuildInfo() public static method

Builds "Info" macro block.

public static BuildInfo ( System.Xml.Linq.XElement body ) : System.Xml.Linq.XElement
body	System.Xml.Linq.XElement
return	System.Xml.Linq.XElement

BuildPageLink() public static method

Builds "Page link" block.

public static BuildPageLink ( string pageTitle ) : System.Xml.Linq.XElement
pageTitle	string
return	System.Xml.Linq.XElement

BuildPageLink() public static method

Builds "Page link" block.

public static BuildPageLink ( string pageTitle, string linkText ) : System.Xml.Linq.XElement
pageTitle	string
linkText	string
return	System.Xml.Linq.XElement

BuildPageLink() public static method

Builds "Page link" block.

public static BuildPageLink ( string pageTitle, string pageAnchor, string linkText ) : System.Xml.Linq.XElement
pageTitle	string
pageAnchor	string
linkText	string
return	System.Xml.Linq.XElement

BuildSection() public static method

Builds "Section" macro block.

public static BuildSection ( System.Xml.Linq.XElement body ) : System.Xml.Linq.XElement
body	System.Xml.Linq.XElement
return	System.Xml.Linq.XElement

BuildStatus() public static method

Builds "Status" macro block.

public static BuildStatus ( string title, StatusColor color, bool outline ) : System.Xml.Linq.XElement
title	string
color	StatusColor
outline	bool
return	System.Xml.Linq.XElement

BuildToc() public static method

Builds "Table of Contents" macro block.

public static BuildToc ( ) : System.Xml.Linq.XElement
return	System.Xml.Linq.XElement

BuildUserLink() public static method

Builds "User link" block.

public static BuildUserLink ( string userKey ) : System.Xml.Linq.XElement
userKey	string
return	System.Xml.Linq.XElement

DecodeEntities() public static method

Encodes all HTML entities back to their original representation.

public static DecodeEntities ( string content ) : string
content	string
return	string

EncodeEntities() public static method

Encodes all HTML entities to avoid confusions for XML parser.

public static EncodeEntities ( string content ) : string
content	string
return	string

Nm() public static method

Builds XML name using internal namespace prefixes.

public static Nm ( string name ) : System.Xml.Linq.XName
name	string
return	System.Xml.Linq.XName

PageDocument() public method

Initializes a new instance.

public PageDocument ( string content = null ) : System
content	string
return	System

Render() public method

Renders page content back to its XML representation.

public Render ( ) : string
return	string