Class COOAR@1.1:StaticTextModule

Defines an abstract object class with the general properties of a static text module.

Class Hierarchy

Object > ContentObject > StaticTextModule

Direct Subclasses

StaticTextModuleText, StaticTextModuleWord

Properties

Type	Property	Name
Room	fldtextmoduleroom	Teamroom
ContentObject[]	moduleplaceholderin	As Text Module Placeholder Embedded in

Actions

Return Type	Signature
object	GetDraftTemplate( out retval object drafttemplate, optional boolean includeself)
boolean	IsDraftTemplate( out retval boolean isdrafttemplate)
object	ReleaseTemplate( out retval object releasedtemplate, optional boolean keepoldrelease, optional dictionary additionalsettings)

Properties

Teamroom (FSCTEMPLATEMGMT@1.1001:fldtextmoduleroom)

Retrieves the room the text module is assigned to.

Room FSCTEMPLATEMGMT@1.1001:fldtextmoduleroom not null readonly

Additional Information

Object Classes Allowed: Room

As Text Module Placeholder Embedded in (COOAR@1.1:moduleplaceholderin)

List of templates that reference this text module as a placeholder.

unique ContentObject[] COOAR@1.1:moduleplaceholderin readonly volatile

Actions

COOTC@1.1001:GetDraftTemplate

Gets the draft version of the template. The action can be called both on the draft version and on the release version of a template.

object COOTC@1.1001:GetDraftTemplate(
out retval object drafttemplate,
optional boolean includeself)

Name	Description
drafttemplate	the draft template
includeself	if set to true and the current object is a draft template (see `COOTC@1.1:objistemplate`) it will return himself

COOTC@1.1001:IsDraftTemplate

Checks if the template is a draft which can be released.

If the release mechanism is to be used for an object class, then this action can be implemented for example with: isdrafttemplate = cooobj.IsUsable() && !cooobj.GetDraftTemplate();

boolean COOTC@1.1001:IsDraftTemplate(
out retval boolean isdrafttemplate)

Name	Description
isdrafttemplate	the result

COOTC@1.1001:ReleaseTemplate

Action to release a template. A released template can be instantiated.

object COOTC@1.1001:ReleaseTemplate(
  out retval object releasedtemplate,
  optional boolean keepoldrelease,
  optional dictionary additionalsettings)

Name	Description
releasedtemplate	the released template
keepoldrelease	in case of newly created released template the old release is not deleted
additionalsettings	this dictionary may contain custom informations when calling the action manually to handle user decision e.g to release sub templates