SmartAPI
Open Source .NET RQL library for RedDot CMS / OpenText WSM Management Server
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | Properties | List of all members
erminas.SmartAPI.CMS.Project.ContentClasses.Elements.IContentClassElement Interface Reference
+ Inheritance diagram for erminas.SmartAPI.CMS.Project.ContentClasses.Elements.IContentClassElement:
+ Collaboration diagram for erminas.SmartAPI.CMS.Project.ContentClasses.Elements.IContentClassElement:

Public Member Functions

void CommitInCurrentLanguage ()
 Save element on the server. Saves only the attributes!
 
void CommitInLanguage (string languageAbbreviation)
 
IContentClassElement CopyToContentClass (IContentClass contentClass)
 Copies the element to another content class by creating a new element and copying the attribute values to it. Make sure to set the language variant in the target project into which the element should be copied, first.
 

Properties

ContentClassCategory Category [get]
 Element category of the lement
 
IContentClass ContentClass [get, set]
 
new string Name [get, set]
 Get/Set the name of the element. If you set the name and call Commit(), the Elements list cache of the ContentClass gets automatically invalidated, so all elements get loaded again, if you access it the next time.
 
ElementType Type [get]
 TypeId of the element.
 

Detailed Description

Definition at line 25 of file IContentClassElement.cs.

Member Function Documentation

void erminas.SmartAPI.CMS.Project.ContentClasses.Elements.IContentClassElement.CommitInCurrentLanguage ( )

Save element on the server. Saves only the attributes!

void erminas.SmartAPI.CMS.Project.ContentClasses.Elements.IContentClassElement.CommitInLanguage ( string  languageAbbreviation)
IContentClassElement erminas.SmartAPI.CMS.Project.ContentClasses.Elements.IContentClassElement.CopyToContentClass ( IContentClass  contentClass)

Copies the element to another content class by creating a new element and copying the attribute values to it. Make sure to set the language variant in the target project into which the element should be copied, first.

Parameters
contentClasstarget content class, into which the element should be copied
Returns
the created copy
  • Override this method, if you need to set other values than the direct attributes of the element (e.g. setting text values of TextHtml elements)
  • The target content class is only modified on the server, thus the content class object does not contain the newly created element. If you need an updated version of the content class, you have to retrieve it again with
    new ContentClass(Project, Guid);

Property Documentation

ContentClassCategory erminas.SmartAPI.CMS.Project.ContentClasses.Elements.IContentClassElement.Category
get

Element category of the lement

Definition at line 30 of file IContentClassElement.cs.

IContentClass erminas.SmartAPI.CMS.Project.ContentClasses.Elements.IContentClassElement.ContentClass
getset

Definition at line 48 of file IContentClassElement.cs.

new string erminas.SmartAPI.CMS.Project.ContentClasses.Elements.IContentClassElement.Name
getset

Get/Set the name of the element. If you set the name and call Commit(), the Elements list cache of the ContentClass gets automatically invalidated, so all elements get loaded again, if you access it the next time.

Definition at line 46 of file IContentClassElement.cs.

ElementType erminas.SmartAPI.CMS.Project.ContentClasses.Elements.IContentClassElement.Type
get

TypeId of the element.

Definition at line 75 of file IContentClassElement.cs.

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