erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant Interface Reference

Inheritance diagram for erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant:

Collaboration diagram for erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant:

Public Member Functions
void	AssignToProjectVariant (IProjectVariant variant, bool doNotPublish, bool doNotUseTidy)
	Assign this template to a specific project variant
void	Commit ()
	Commit changes to attriubtes to the server. If you change the template content (Data property), you don't need to call this method.
void	CopyToContentClass (IContentClass target)
	Copy this template over to another content class
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
bool	ContainsAreaMarksInPage [get, set]
IContentClass	ContentClass [get]
DateTime	CreationDate [get]
	Timestamp of the creation of the template
IUser	CreationUser [get]
	User who created the template
string	Data [get, set]
	Content data of the template (template text). This gets changed immediately on server. No need to call commit afterwards
string	Description [get, set]
	Description of the template
string	FileExtension [get, set]
IRedDotObject	Handle [get]
bool	HasContainerPageReference [get, set]
bool	IsLocked [get]
bool	IsStylesheetIncludedInHeader [get, set]
	Denoting whether or not a stylesheet should be automatically built into the header area of a page.
DateTime	LastChangeDate [get]
	Timestamp of the last change to the template
IUser	LastChangeUser [get]
	User who last changed the template
new string	Name [get, set]
PdfOrientation	PdfOrientation [get, set]
TemplateVariantState	ReleaseStatus [get]
	Current release status of the template
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 26 of file ITemplateVariant.cs.

Member Function Documentation

void erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.AssignToProjectVariant	(	IProjectVariant	variant,
		bool	doNotPublish,
		bool	doNotUseTidy
	)

Assign this template to a specific project variant

void erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.Commit

(

)

Commit changes to attriubtes to the server. If you change the template content (Data property), you don't need to call this method.

void erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.CopyToContentClass

(

IContentClass

target

)

Copy this template over to another content class

Parameters

target

Property Documentation

bool erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.ContainsAreaMarksInPage

getset

Definition at line 37 of file ITemplateVariant.cs.

IContentClass erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.ContentClass

get

Definition at line 39 of file ITemplateVariant.cs.

DateTime erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.CreationDate

get

Timestamp of the creation of the template

Definition at line 50 of file ITemplateVariant.cs.

IUser erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.CreationUser

get

User who created the template

Definition at line 55 of file ITemplateVariant.cs.

string erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.Data

getset

Content data of the template (template text). This gets changed immediately on server. No need to call commit afterwards

Definition at line 60 of file ITemplateVariant.cs.

string erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.Description

getset

Description of the template

Definition at line 71 of file ITemplateVariant.cs.

string erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.FileExtension

getset

Definition at line 73 of file ITemplateVariant.cs.

IRedDotObject erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.Handle

get

Definition at line 74 of file ITemplateVariant.cs.

bool erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.HasContainerPageReference

getset

Definition at line 75 of file ITemplateVariant.cs.

bool erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.IsLocked

get

Definition at line 76 of file ITemplateVariant.cs.

bool erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.IsStylesheetIncludedInHeader

getset

Denoting whether or not a stylesheet should be automatically built into the header area of a page.

Definition at line 81 of file ITemplateVariant.cs.

DateTime erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.LastChangeDate

get

Timestamp of the last change to the template

Definition at line 86 of file ITemplateVariant.cs.

IUser erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.LastChangeUser

get

User who last changed the template

Definition at line 91 of file ITemplateVariant.cs.

new string erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.Name

getset

Definition at line 29 of file ITemplateVariant.cs.

PdfOrientation erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.PdfOrientation

getset

Definition at line 93 of file ITemplateVariant.cs.

TemplateVariantState erminas.SmartAPI.CMS.Project.ContentClasses.ITemplateVariant.ReleaseStatus

get

Current release status of the template

Definition at line 98 of file ITemplateVariant.cs.

---

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

• ITemplateVariant.cs