C# Class XWiki.Model.Wiki

Show file Open project: xwiki-contrib/xwiki-office Class Usage Examples

Public Properties

Property Type Description
spaces List

Public Methods

Method Description
AddSpaces ( IEnumerable _spaces ) : void

Adds a collection of spaces to the wiki.
AddSpaces ( IEnumerable _spaces ) : void

Adds a collection of spaces to the wiki.
ContainsSpace ( string spaceName ) : bool

Specifies if the wiki contains a given space.
GetAllDocuments ( ) : List

Gets all document instances in the wiki.
GetPageById ( String pageFullName ) : XWikiDocument

Gets the XWiki Document for a given id.
GetUnpublishedWikiStructure ( ) : Wiki

Gets the unplublished spaces and documents from wiki structure instance.
RemoveXWikiDocument ( XWikiDocument doc ) : void

Removes a XWikiDocument instance from the wiki structure. This has no effect on the server. It only affects the document list Word works with.
Wiki ( ) : System

Default constructor. Instantiates the spaces list.
this ( String spaceName ) : Space

Wiki indexer. Gets the instance of the specified space in the wiki.

Method Details

AddSpaces() public method

Adds a collection of spaces to the wiki.
public AddSpaces ( IEnumerable _spaces ) : void
_spaces IEnumerable
return void

AddSpaces() public method

Adds a collection of spaces to the wiki.
public AddSpaces ( IEnumerable _spaces ) : void
_spaces IEnumerable
return void

ContainsSpace() public method

Specifies if the wiki contains a given space.
public ContainsSpace ( string spaceName ) : bool
spaceName string The name of the searched space.
return bool

GetAllDocuments() public method

Gets all document instances in the wiki.
public GetAllDocuments ( ) : List
return List

GetPageById() public method

Gets the XWiki Document for a given id.
public GetPageById ( String pageFullName ) : XWikiDocument
pageFullName String The full name of the page.
return XWikiDocument

GetUnpublishedWikiStructure() public method

Gets the unplublished spaces and documents from wiki structure instance.
public GetUnpublishedWikiStructure ( ) : Wiki
return Wiki

RemoveXWikiDocument() public method

Removes a XWikiDocument instance from the wiki structure. This has no effect on the server. It only affects the document list Word works with.
public RemoveXWikiDocument ( XWikiDocument doc ) : void
doc XWikiDocument
return void

Wiki() public method

Default constructor. Instantiates the spaces list.
public Wiki ( ) : System
return System

this() public method

Wiki indexer. Gets the instance of the specified space in the wiki.
public this ( String spaceName ) : Space
spaceName String The name of the wiki space.
return Space

Property Details

spaces public property

A list with all spaces in the wiki.
public List spaces
return List