Class FSCUSERFORMS@1.1001:UserForm

User form.

Explanation:
By defining your own Forms, enhance documents and other objects with additional fields.

Class Hierarchy

Properties

Type	Property	Name
Content	content	File
LanguageStringList[]	mlname	Multilingual Name

Actions

Return Type	Signature
boolean	AllowNavigateDraftRelease( out retval boolean allownavigate, optional object template)
boolean	CanReleaseTemplate( out retval boolean canrelease)
object	InstantiateTemplateObject( optional boolean skipinvalidtextmodules, out object[] invalidtextmodules, out retval object object)
boolean	IsDraftTemplate( out retval boolean isdrafttemplate)
boolean	IsTemplateReleased( out retval boolean isreleased, out optional object releasedtemplate)
object	ObjectCopy( ref optional object placement, out retval object object, optional string address, optional boolean virtualobject)
object	ReleaseTemplate( out retval object releasedtemplate, optional boolean keepoldrelease, optional dictionary additionalsettings)
void	RevokeReleasedTemplate( optional dictionary additionalsettings)

Properties

File (COOSYSTEM@1.1:content)

Defines the multimedia content of the object and information like the size of the content or the date of the last change.

Explanation:
Defines the content.

Content COOSYSTEM@1.1:content

Additional Information

Access Types for Changing Property: AccTypeChangeContent
Access Types for Reading Property: AccTypeReadContent

Multilingual Name (COOSYSTEM@1.1:mlname)

Defines the multilingual name of the object. It stores one name for each supported language.

Explanation:
This field defines the multilingual name of the object.

unique LanguageStringList[] COOSYSTEM@1.1:mlname

Actions

COOTC@1.1001:AllowNavigateDraftRelease

This action is used in the dynamic menu action of the template management to decide if the option to navigate from the draft to the release version and backwards should be available.

boolean COOTC@1.1001:AllowNavigateDraftRelease(
out retval boolean allownavigate,
optional object template)

Name	Description
allownavigate	the result
template

COOTC@1.1001:CanReleaseTemplate

Check if the current user is allowed to release a template or to withdraw the release

boolean COOTC@1.1001:CanReleaseTemplate(
out retval boolean canrelease)

Name	Description
canrelease	the result;

FSCTEMPLATEMGMT@1.1001:InstantiateTemplateObject

Instantiates a template object and resolve linked text modules. After calling template.InstantiateTemplateObject(), the transaction must be committed before InstantiateTemplateObject() is called again for another template.

object FSCTEMPLATEMGMT@1.1001:InstantiateTemplateObject(
  optional boolean skipinvalidtextmodules,
  out object[] invalidtextmodules,
  out retval object object)

Name	Description
skipinvalidtextmodules	skip invalid text modules
invalidtextmodules	list of invalid text modules
object	the instantiated object

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:IsTemplateReleased

Check if a template is already released

boolean COOTC@1.1001:IsTemplateReleased(
out retval boolean isreleased,
out optional object releasedtemplate)

Name	Description
isreleased	the result
releasedtemplate

COOSYSTEM@1.1:ObjectCopy

Creates a new object as the copy of the object. This action called on the source object. This action sets the property objsource on the copied object.

object COOSYSTEM@1.1:ObjectCopy(
  ref optional object placement,
  out retval object object,
  optional string address,
  optional boolean virtualobject)

Name	Description
placement
object	The created copy of the object.
address	The object address for the new object. If this parameter is used, it overrides the specified COO store in parameter `coost` or the automatically chosen COO store, if no COO store was specified.
virtualobject

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

COOTC@1.1001:RevokeReleasedTemplate

Marks an released template as no longer released, so the template can no longer be instantiated

void COOTC@1.1001:RevokeReleasedTemplate(
optional dictionary additionalsettings)

Name	Description
additionalsettings	this dictionary may contain custom informations when calling the action manually to handle user decision e.g to withdraw release of sub templates