2022 June Release

Actions of COOMSOFFICE@1.1:WinWordObject Permanent link for this heading

Return Type

Signature

void

ApplyDocumentProperties(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

void

AttrContentSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

boolean

CanBePersonalized(
  out retval boolean personalizable)

void

EditObjectAsMailMerge(
  optional integer unused1,
  optional integer unused2)

Action

GetOpenOnlineAction(
  out retval Action openaction)

dictionary

GetPageTemplateVisibilitySettings(
  string title,
  object context,
  out retval dictionary tpsettings)

string[]

GetRobinsonEntries(
  out retval string[] entries)

void

InitializeAggregateIterator(
  out dictionary state,
  optional object attrdef)

boolean

IsFieldsIntegrationEnabled(
  out retval boolean allowed)

boolean

IsMailMergeActive(
  out retval boolean active)

void

IterateAggregate(
  ref dictionary state,
  out any aggr)

void

IterateAggregateSet(
  dictionary state,
  any aggr)

void

OpenObjectAsMailMerge(
  optional integer unused1,
  optional integer unused2)

void

PatchContent(
  PatchContentType[] type,
  ref string filename,
  out boolean modified)

void

ResolveAllTextModules()

void

ResolveTextModules()

void

UpdatePictures(
  string[] alternativetexts,
  any[] pictures)

void

UpdateTable(
  string alternativetext,
  any[] entries,
  AttributeDefinition[] attributes,
  optional boolean includeheaders)

void

UpdateTables(
  optional integer unused1,
  optional integer unused2)

boolean

UseOpenOnline(
  out retval boolean useonline,
  ref OpenDocumentMode opendocmode)

boolean

UseOpenOnlinePreview(
  out retval boolean useonlinepreview)


FSCCONV@1.1001:ApplyDocumentProperties Permanent link for this heading

void FSCCONV@1.1001:ApplyDocumentProperties(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


COOSYSTEM@1.1:AttrContentSet Permanent link for this heading

Sets a content property of the object. This action is called by the kernel before the changed properties are stored.

void COOSYSTEM@1.1:AttrContentSet(
  AttributeDefinition attrdef,
  ref optional any value,
  any oldvalue)

Name

Description

attrdef

value

oldvalue

Additional Information


FSCFOLIO@1.1001:CanBePersonalized Permanent link for this heading

boolean FSCFOLIO@1.1001:CanBePersonalized(
  out retval boolean personalizable)

Name

Description

personalizable

Additional Information


FSCFOLIO@1.1001:EditObjectAsMailMerge Permanent link for this heading

Usecase to open a content object with merge fields

void FSCFOLIO@1.1001:EditObjectAsMailMerge(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENV@1.1001:GetOpenOnlineAction Permanent link for this heading

Get the action which is called when an object is opened with an online tool

Action FSCVENV@1.1001:GetOpenOnlineAction(
  out retval Action openaction)

Name

Description

openaction

Additional Information


FSCTEMPLATEMGMT@1.1001:GetPageTemplateVisibilitySettings Permanent link for this heading

Calculate the visibility of the generic template page

dictionary FSCTEMPLATEMGMT@1.1001:GetPageTemplateVisibilitySettings(
  string title,
  object context,
  out retval dictionary tpsettings)

Name

Description

title

context

tpsettings

Additional Information


FSCFOLIO@1.1001:GetRobinsonEntries Permanent link for this heading

string[] FSCFOLIO@1.1001:GetRobinsonEntries(
  out retval string[] entries)

Name

Description

entries

Additional Information


FSCSELECT@1.1001:InitializeAggregateIterator Permanent link for this heading

void FSCSELECT@1.1001:InitializeAggregateIterator(
  out dictionary state,
  optional object attrdef)

Name

Description

state

attrdef

Additional Information


FSCVENV@1.1001:IsFieldsIntegrationEnabled Permanent link for this heading

Returns if the fields integration is enabled.

boolean FSCVENV@1.1001:IsFieldsIntegrationEnabled(
  out retval boolean allowed)

Name

Description

allowed

returns true if the fields integration is enabled for the object

Additional Information


FSCVENVUI@1.1001:IsMailMergeActive Permanent link for this heading

Check if object is marked as mailmerge object

boolean FSCVENVUI@1.1001:IsMailMergeActive(
  out retval boolean active)

Name

Description

active

returns true if the object is a mailmerge object

Additional Information


FSCSELECT@1.1001:IterateAggregate Permanent link for this heading

void FSCSELECT@1.1001:IterateAggregate(
  ref dictionary state,
  out any aggr)

Name

Description

state

aggr

Additional Information


FSCSELECT@1.1001:IterateAggregateSet Permanent link for this heading

void FSCSELECT@1.1001:IterateAggregateSet(
  dictionary state,
  any aggr)

Name

Description

state

aggr

Additional Information


FSCFOLIO@1.1001:OpenObjectAsMailMerge Permanent link for this heading

Usecase to open a content object with merge fields

void FSCFOLIO@1.1001:OpenObjectAsMailMerge(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


COOSYSTEM@1.1:PatchContent Permanent link for this heading

void COOSYSTEM@1.1:PatchContent(
  PatchContentType[] type,
  ref string filename,
  out boolean modified)

Name

Description

type

filename

modified

Additional Information


FSCPOI@1.1001:ResolveAllTextModules Permanent link for this heading

Resolves all Text Module Placeholders in cooobj. (Even those where keepplaceholder == true) Use ResolveTextModules instead.

void FSCPOI@1.1001:ResolveAllTextModules()

Additional Information


FSCTEMPLATEMGMT@1.1001:ResolveTextModules Permanent link for this heading

Resolves Text Module Placeholders in cooobj. (Even those where keepplaceholder == true)

void FSCTEMPLATEMGMT@1.1001:ResolveTextModules()

Additional Information


FSCAPPTOOLS@1.1001:UpdatePictures Permanent link for this heading

Updates pictures in a Microsoft Word file.

void FSCAPPTOOLS@1.1001:UpdatePictures(
  string[] alternativetexts,
  any[] pictures)

Name

Description

alternativetexts

Alternative text identifiers of pictures in the Microsoft Word file

pictures

Pictures (either objects of class ContentObject or aggregates of type Content)

Additional Information


FSCAPPTOOLS@1.1001:UpdateTable Permanent link for this heading

Updates a table in a Microsoft Word file.
If the value of a cell contains the string "<~null~>" the cell is blanked.
If the value of a cell contains the string "<~leave~>" the cell is not changed.

void FSCAPPTOOLS@1.1001:UpdateTable(
  string alternativetext,
  any[] entries,
  AttributeDefinition[] attributes,
  optional boolean includeheaders)

Name

Description

alternativetext

Alternative text identifier of table in the Microsoft Word file

entries

Lines of the table (either objects or aggregates)

attributes

Columns of the table

includeheaders

Use names of attributes as the first row

Additional Information


FSCAPPTOOLS@1.1001:UpdateTables Permanent link for this heading

Updates any tables in Microsoft Word document.
A table is identified by an object list or an aggregate list of the category of the object or its file.
For an object list, all visible attributes of the default category of the attribute are generated.
For an aggregate list, all visible attributes of the aggregate are generated. All aggregates must have the same type.
No header data is generated.
The short reference of the attribute surrounded by "<" and ">" is used as identifier of a table.
A table in Microsoft Word must be marked with an alternative text that corresponds to the identifier of the attribute. If the value of a cell contains the string "<~null~>" the cell is blanked.
If the value of a cell contains the string "<~leave~>" the cell is not changed.

void FSCAPPTOOLS@1.1001:UpdateTables(
  optional integer unused1,
  optional integer unused2)

Name

Description

unused1

unused2

Additional Information


FSCVENV@1.1001:UseOpenOnline Permanent link for this heading

Decides whether online editing or online reading should be used

boolean FSCVENV@1.1001:UseOpenOnline(
  out retval boolean useonline,
  ref OpenDocumentMode opendocmode)

Name

Description

useonline

opendocmode

available open modes

Additional Information


FSCVENV@1.1001:UseOpenOnlinePreview Permanent link for this heading

Decides whether preview should be displayed with online tool

boolean FSCVENV@1.1001:UseOpenOnlinePreview(
  out retval boolean useonlinepreview)

Name

Description

useonlinepreview

Additional Information