C# Class erminas.SmartAPI.CMS.Project.Keywords.Category

A category entry of a project in the RedDot server.

Inheritance: PartialRedDotProjectObject, ICategory

Exibir arquivo Open project: erminas/smartapi

Public Methods

Method	Description
Category ( IProject project, System.Guid guid ) : System
Commit ( ) : void	Use after setting Name to rename category on the server.
Delete ( ) : void	Delete the category. The operation will fail, if a keyword is still assigned to a page
DeleteForcibly ( ) : void	Delete the category, even if its keywords are actively used in connecting pages to containers/lists. This requires the session to contain your login password (it does, if you created the session object with valid ServerLogin.AuthData).
Rename ( string newCategoryName ) : void	Renames the category directly on the server. Thus it is the same as: `string newCategoryName = ...; category.Name = newCategoryName; category.Commit();`

Protected Methods

Method	Description
LoadWholeObject ( ) : void
RetrieveWholeObject ( ) : XmlElement

Private Methods

Method	Description
Category ( IProject project, XmlElement xmlElement ) : System
IsCategoryStillUsed ( XmlElement category ) : bool
LoadXml ( ) : void

Method Details

Category() public method

public Category ( IProject project, System.Guid guid ) : System
project	IProject
guid	System.Guid
return	System

Commit() public method

Use after setting Name to rename category on the server.

public Commit ( ) : void
return	void

Delete() public method

Delete the category. The operation will fail, if a keyword is still assigned to a page

Thrown, if the category couldn't be deleted

public Delete ( ) : void
return	void

DeleteForcibly() public method

Delete the category, even if its keywords are actively used in connecting pages to containers/lists. This requires the session to contain your login password (it does, if you created the session object with valid ServerLogin.AuthData).

Thrown, if the category could not be deleted

public DeleteForcibly ( ) : void
return	void

LoadWholeObject() protected method

protected LoadWholeObject ( ) : void
return	void

Rename() public method

Renames the category directly on the server. Thus it is the same as:

 string newCategoryName = ...; 
 category.Name = newCategoryName;
  category.Commit();

public Rename ( string newCategoryName ) : void
newCategoryName	string
return	void

RetrieveWholeObject() protected method

protected RetrieveWholeObject ( ) : XmlElement
return	System.Xml.XmlElement