erminas.SmartAPI.CMS.Project.Keywords.ICategory Interface Reference

Inheritance diagram for erminas.SmartAPI.CMS.Project.Keywords.ICategory:

Collaboration diagram for erminas.SmartAPI.CMS.Project.Keywords.ICategory:

Public Member Functions
void	Commit ()
	Use after setting Name to rename category on the server.
new void	Delete ()
	Delete the category. The operation will fail, if a keyword is still assigned to a page
void	DeleteForcibly ()
	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).
void	Rename (string newCategoryName)
	Renames the category directly on the server. Thus it is the same as:
Public Member Functions inherited from erminas.SmartAPI.CMS.IPartialRedDotObject
void	EnsureInitialization ()
void	Refresh ()
Public Member Functions inherited from erminas.SmartAPI.CMS.IDeletable
void	Delete ()

Properties
CategoryKeywords	Keywords [get]
ILanguageVariant	LanguageVariant [get]
	The current language variant.
Properties inherited from erminas.SmartAPI.CMS.Project.IProjectObject
IProject	Project [get]
Properties inherited from erminas.SmartAPI.CMS.ISessionObject
ISession	Session [get]

Detailed Description

Definition at line 24 of file ICategory.cs.

Member Function Documentation

void erminas.SmartAPI.CMS.Project.Keywords.ICategory.Commit

(

)

Use after setting Name to rename category on the server.

new void erminas.SmartAPI.CMS.Project.Keywords.ICategory.Delete

(

)

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

Exceptions

SmartAPIException

Thrown, if the category couldn't be deleted

Here is the caller graph for this function:

void erminas.SmartAPI.CMS.Project.Keywords.ICategory.DeleteForcibly

(

)

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).

Exceptions

SmartAPIException

Thrown, if the category could not be deleted

void erminas.SmartAPI.CMS.Project.Keywords.ICategory.Rename

(

string

newCategoryName

)

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

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

Property Documentation

CategoryKeywords erminas.SmartAPI.CMS.Project.Keywords.ICategory.Keywords

get

Definition at line 44 of file ICategory.cs.

ILanguageVariant erminas.SmartAPI.CMS.Project.Keywords.ICategory.LanguageVariant

get

The current language variant.

Definition at line 49 of file ICategory.cs.

---

The documentation for this interface was generated from the following file:

• ICategory.cs