ANSYS ACT XML Reference Guide

ACT XML Reference Guide
ANSYS, Inc. Release 2020 R1

Southpointe January 2020
2600 ANSYS Drive
Canonsburg, PA 15317 ANSYS, Inc. and
ansysinfo@ansys.com ANSYS Europe,
Ltd. are UL
http://www.ansys.com registered ISO
(T) 724-746-3304 9001: 2015
(F) 724-514-9494 companies.
Copyright and Trademark Information
© 2020 ANSYS, Inc. Unauthorized use, distribution or duplication is prohibited.
ANSYS, ANSYS Workbench, AUTODYN, CFX, FLUENT and any and all ANSYS, Inc. brand, product, service and feature
names, logos and slogans are registered trademarks or trademarks of ANSYS, Inc. or its subsidiaries located in the
United States or other countries. ICEM CFD is a trademark used by ANSYS, Inc. under license. CFX is a trademark
of Sony Corporation in Japan. All other brand, product, service and feature names or trademarks are the property
of their respective owners. FLEXlm and FLEXnet are trademarks of Flexera Software LLC.
Disclaimer Notice
THIS ANSYS SOFTWARE PRODUCT AND PROGRAM DOCUMENTATION INCLUDE TRADE SECRETS AND ARE CONFID-
ENTIAL AND PROPRIETARY PRODUCTS OF ANSYS, INC., ITS SUBSIDIARIES, OR LICENSORS. The software products
and documentation are furnished by ANSYS, Inc., its subsidiaries, or affiliates under a software license agreement
that contains provisions concerning non-disclosure, copying, length and nature of use, compliance with exporting
laws, warranties, disclaimers, limitations of liability, and remedies, and other provisions. The software products
and documentation may be used, disclosed, transferred, or copied only in accordance with the terms and conditions
of that software license agreement.
ANSYS, Inc. and ANSYS Europe, Ltd. are UL registered ISO 9001: 2015 companies.
U.S. Government Rights
For U.S. Government users, except as specifically granted by the ANSYS, Inc. software license agreement, the use,
duplication, or disclosure by the United States Government is subject to restrictions stated in the ANSYS, Inc.
software license agreement and FAR 12.212 (for non-DOD licenses).
Third-Party Software
See the legal information in the product help files for the complete Legal Notice for ANSYS proprietary software
and third-party software. If you are unable to access the Legal Notice, contact ANSYS, Inc.
Published in the U.S.A.

Table of Contents
ACT XML Reference ..................................................................................................................................... 1
ACT XML Tags ........................................................................................................................................ 3
<action> .......................................................................................................................................... 6
<ConnectTo> ............................................................................................................................. 6
<InputValue> ............................................................................................................................. 7
Name= ....................................................................................................................................... 8
Type= ......................................................................................................................................... 9
<ActionCallback> ........................................................................................................................... 10
caninterrupt= ........................................................................................................................... 10
caption= .................................................................................................................................. 11
icon= ....................................................................................................................................... 12
name= ..................................................................................................................................... 13
<actions> ....................................................................................................................................... 14
<Action> .................................................................................................................................. 14
<Operator> .............................................................................................................................. 15
MainAction= ............................................................................................................................ 16
Name= ..................................................................................................................................... 17
<ActionsView> ............................................................................................................................... 17
<StandardAction> .................................................................................................................... 18
component= ............................................................................................................................ 19
name= ..................................................................................................................................... 19
<Application> ................................................................................................................................ 20
<actions> ................................................................................................................................. 21
<ApplicationWorkflow> ............................................................................................................ 22
<Callbacks> .............................................................................................................................. 23
<canstart> ............................................................................................................................... 24
<DataModel> ........................................................................................................................... 25
<Description> .......................................................................................................................... 25
<OnApplicationFinished> ......................................................................................................... 26
<OnApplicationStarted> .......................................................................................................... 27
<OnBeforeProjectClosed> ........................................................................................................ 28
<OnBeforeSave> ...................................................................................................................... 29
<OnProjectLoaded> ................................................................................................................. 30
<Panel> ................................................................................................................................... 31
<Presentations> ....................................................................................................................... 31
<ProductDataModelConverter> ................................................................................................ 32
caption= .................................................................................................................................. 33
class= ....................................................................................................................................... 34
context= .................................................................................................................................. 35
icon= ....................................................................................................................................... 35
name= ..................................................................................................................................... 36
projectExtName= ..................................................................................................................... 37
version= ................................................................................................................................... 38
WorkflowToStart= ..................................................................................................................... 39
<argument> ................................................................................................................................... 40
name= ..................................................................................................................................... 40
separator= ................................................................................................................................ 41
value= ...................................................................................................................................... 42
<assembly> .................................................................................................................................... 43
context= .................................................................................................................................. 44
Release 2020 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. iii
namespace= ............................................................................................................................. 45
src= .......................................................................................................................................... 46
<attributes> ................................................................................................................................... 46
<BrowserView> .............................................................................................................................. 47
name= ..................................................................................................................................... 47
<Callback> ..................................................................................................................................... 48
caninterrupt= ........................................................................................................................... 48
<CallbackEvaluate> ........................................................................................................................ 49
caninterrupt= ........................................................................................................................... 50
InvokeUIThread= ...................................................................................................................... 51
<CallbackGetCommands> .............................................................................................................. 51
caninterrupt= ........................................................................................................................... 52
InvokeUIThread= ...................................................................................................................... 53
location= .................................................................................................................................. 54
order= ...................................................................................................................................... 55
<CallbackGetPostPreSolveCommands> .......................................................................................... 56
caninterrupt= ........................................................................................................................... 56
order= ...................................................................................................................................... 57
timedependent= ...................................................................................................................... 58
<CallbackOnActiveObjectChange> ................................................................................................. 59
caninterrupt= ........................................................................................................................... 59
name= ..................................................................................................................................... 60
type= ....................................................................................................................................... 61
<CallbackOnGenerate> .................................................................................................................. 62
caninterrupt= ........................................................................................................................... 62
InvokeUIThread= ...................................................................................................................... 63
<CallbackOnSolve> ........................................................................................................................ 64
caninterrupt= ........................................................................................................................... 64
InvokeUIThread= ...................................................................................................................... 65
<Callbacks> .................................................................................................................................... 66
<Callback> ............................................................................................................................... 67
<Component> ............................................................................................................................... 67
<Attributes> ............................................................................................................................. 68
BottomAttachment= ................................................................................................................ 69
BottomOffset= ......................................................................................................................... 70
ComponentType= .................................................................................................................... 71
CustomCSSFile= ....................................................................................................................... 72
CustomHTMLFile= .................................................................................................................... 73
CustomJSFile= .......................................................................................................................... 74
Height= .................................................................................................................................... 74
HeightType= ............................................................................................................................ 75
LeftAttachment= ...................................................................................................................... 76
LeftOffset= ............................................................................................................................... 77
MaxHeight= ............................................................................................................................. 78
MaxWidth= .............................................................................................................................. 79
MinHeight= .............................................................................................................................. 80
MinWidth= ............................................................................................................................... 81
name= ..................................................................................................................................... 82
RightAttachment= .................................................................................................................... 83
RightOffset= ............................................................................................................................. 84
TopAttachment= ...................................................................................................................... 84
TopOffset= ............................................................................................................................... 85
iv of ANSYS, Inc. and its subsidiaries and affiliates.
visible= .................................................................................................................................... 86
Width= ..................................................................................................................................... 87
WidthType= ............................................................................................................................. 88
<ComponentData> ........................................................................................................................ 89
component= ............................................................................................................................ 89
<ComponentDefinition> ................................................................................................................ 90
Class= ...................................................................................................................................... 91
CSSFile= ................................................................................................................................... 92
DataModelClass= ..................................................................................................................... 93
Directory= ................................................................................................................................ 94
HTMLFile= ................................................................................................................................ 94
JSFile= ...................................................................................................................................... 95
Name= ..................................................................................................................................... 96
<ComponentStyle> ........................................................................................................................ 97
component= ............................................................................................................................ 98
filter= ....................................................................................................................................... 99
<connectTo> .................................................................................................................................. 99
action= ................................................................................................................................... 100
event= ................................................................................................................................... 101
<contextmenus> .......................................................................................................................... 102
<UIEntry> ............................................................................................................................... 102
<ControlTemplate> ...................................................................................................................... 103
<Property> ............................................................................................................................. 103
name= ................................................................................................................................... 104
version= ................................................................................................................................. 105
<datamodel> ............................................................................................................................... 106
name= ................................................................................................................................... 106
<DataModel> ............................................................................................................................... 107
<UserObject> ......................................................................................................................... 107
icon= ...................................................................................................................................... 108
name= ................................................................................................................................... 109
<DataModelView> ........................................................................................................................ 110
chartComponent= .................................................................................................................. 110
dataModel= ............................................................................................................................ 111
imageComponent= ................................................................................................................ 112
name= ................................................................................................................................... 113
presentation= ......................................................................................................................... 114
propertiesComponent= .......................................................................................................... 115
sceneComponent= ................................................................................................................. 116
tabularComponent= ............................................................................................................... 117
treeComponent= .................................................................................................................... 118
<DialogProgressMonitorView> ..................................................................................................... 119
<task> .................................................................................................................................... 119
name= ................................................................................................................................... 120
<entity> ....................................................................................................................................... 121
<Attributes> ........................................................................................................................... 122
<Callbacks> ............................................................................................................................ 123
<CanAdd> .............................................................................................................................. 123
<CanDuplicate> ..................................................................................................................... 124
<CanRemove> ........................................................................................................................ 125
<IsValid> ................................................................................................................................ 126
<OnAdd> ............................................................................................................................... 127
of ANSYS, Inc. and its subsidiaries and affiliates. v
<OnAfterGeometryUpdate> ................................................................................................... 128

<OnBodySuppressStateChange> ............................................................................................ 129
<OnClearData> ...................................................................................................................... 130
<OnDuplicate> ....................................................................................................................... 131
<OnGenerateData> ................................................................................................................ 132
<OnHide> .............................................................................................................................. 133
<OnInit> ................................................................................................................................ 134
<OnMigrate> .......................................................................................................................... 135
<OnReady> ............................................................................................................................ 136
<OnRemove> ......................................................................................................................... 137
<OnShow> ............................................................................................................................. 138
<OnSuppress> ....................................................................................................................... 139
<OnUnsuppress> ................................................................................................................... 140
<Property> ............................................................................................................................. 141
caption= ................................................................................................................................ 142
class= ..................................................................................................................................... 143
contextual= ............................................................................................................................ 144
datatype= .............................................................................................................................. 145
icon= ...................................................................................................................................... 146
name= ................................................................................................................................... 147
version= ................................................................................................................................. 148
<entry> ........................................................................................................................................ 148
<Callbacks> ............................................................................................................................ 149
<Entry> .................................................................................................................................. 150
<OnClick> .............................................................................................................................. 150
caption= ................................................................................................................................ 151
Icon= ...................................................................................................................................... 152
name= ................................................................................................................................... 153
userobject= ............................................................................................................................ 154
<entry> ........................................................................................................................................ 155
<Callbacks> ............................................................................................................................ 156
<onclick> ............................................................................................................................... 156
caption= ................................................................................................................................ 157
icon= ...................................................................................................................................... 158
name= ................................................................................................................................... 159
priority= ................................................................................................................................. 160
type= ..................................................................................................................................... 161
version= ................................................................................................................................. 162
<Extension> ................................................................................................................................. 163
<Application> ........................................................................................................................ 164
<appStoreId> ......................................................................................................................... 165
<assembly> ............................................................................................................................ 165
<author> ................................................................................................................................ 166
<description> ......................................................................................................................... 167
<Guid> ................................................................................................................................... 167
<ImageDirectory> .................................................................................................................. 168
<Interface> ............................................................................................................................ 169
<Licenses> ............................................................................................................................. 169
<script> ................................................................................................................................. 170
<simdata> .............................................................................................................................. 171
<Templates> .......................................................................................................................... 171
<UIDefinition> ....................................................................................................................... 172
vi of ANSYS, Inc. and its subsidiaries and affiliates.
<Wizard> ............................................................................................................................... 173

<Workflow> ........................................................................................................................... 173
debug= .................................................................................................................................. 174
icon= ...................................................................................................................................... 175
isNative= ................................................................................................................................ 176
loadAsDefault= ....................................................................................................................... 177
masked= ................................................................................................................................ 178
minorversion= ........................................................................................................................ 179
name= ................................................................................................................................... 180
ReadPythonFiles= ................................................................................................................... 181
version= ................................................................................................................................. 181
<ExtensionObject> ....................................................................................................................... 182
<Attributes> ........................................................................................................................... 184
<Callbacks> ............................................................................................................................ 185
<CanAdd> .............................................................................................................................. 185
<CanDuplicate> ..................................................................................................................... 186
<CanRemove> ........................................................................................................................ 187
<HostObjectModified> ........................................................................................................... 188
<IsValid> ................................................................................................................................ 189
<OnAdd> ............................................................................................................................... 190
<OnClearData> ...................................................................................................................... 193
<OnDuplicate> ....................................................................................................................... 194
<OnGenerateData> ................................................................................................................ 195
<OnHide> .............................................................................................................................. 196
<OnInit> ................................................................................................................................ 197
<OnMigrate> .......................................................................................................................... 198
<OnReady> ............................................................................................................................ 199
<OnRemove> ......................................................................................................................... 200
<OnShow> ............................................................................................................................. 201
<OnSuppress> ....................................................................................................................... 202
<OnUnsuppress> ................................................................................................................... 203
<Property> ............................................................................................................................. 204
<Target> ................................................................................................................................ 205
caption= ................................................................................................................................ 206
class= ..................................................................................................................................... 207
contextual= ............................................................................................................................ 208
icon= ...................................................................................................................................... 208
name= ................................................................................................................................... 209
version= ................................................................................................................................. 210
<FileToolbarView> ........................................................................................................................ 211
buttonsComponent= .............................................................................................................. 212
name= ................................................................................................................................... 213
<filter> ......................................................................................................................................... 213
name= ................................................................................................................................... 214
src= ........................................................................................................................................ 215
<Geometry> ................................................................................................................................. 216
<Attributes> ........................................................................................................................... 217
<Callbacks> ............................................................................................................................ 218
<CanAdd> .............................................................................................................................. 219
<CanDuplicate> ..................................................................................................................... 220
of ANSYS, Inc. and its subsidiaries and affiliates. vii
<CanRemove> ........................................................................................................................ 221

<IsValid> ................................................................................................................................ 222
<OnAdd> ............................................................................................................................... 223
<OnAfterGenerate> ................................................................................................................ 224
<OnClearData> ...................................................................................................................... 227
<OnDuplicate> ....................................................................................................................... 228
<OnEdit> ............................................................................................................................... 229
<OnGenerate> ....................................................................................................................... 230
<OnGenerateData> ................................................................................................................ 231
<OnHide> .............................................................................................................................. 232
<OnInit> ................................................................................................................................ 233
<OnMigrate> .......................................................................................................................... 234
<OnReady> ............................................................................................................................ 235
<OnRemove> ......................................................................................................................... 236
<OnShow> ............................................................................................................................. 237
<OnSuppress> ....................................................................................................................... 238
<OnUnsuppress> ................................................................................................................... 239
<Property> ............................................................................................................................. 240
caption= ................................................................................................................................ 240
class= ..................................................................................................................................... 241
contextual= ............................................................................................................................ 242
icon= ...................................................................................................................................... 243
name= ................................................................................................................................... 244
version= ................................................................................................................................. 245
<guid> ......................................................................................................................................... 246
shortid= ................................................................................................................................. 246
<Image> ...................................................................................................................................... 247
<Callbacks> ............................................................................................................................ 248
<OnAdd> ............................................................................................................................... 249
<OnDelete> ........................................................................................................................... 250
<OnHighlight> ....................................................................................................................... 251
<OnUnhighlight> ................................................................................................................... 252
<OnUpdate> .......................................................................................................................... 253
allowHighlight= ...................................................................................................................... 254
FileNameProperty= ................................................................................................................. 254
userObject= ........................................................................................................................... 255
visibility= ................................................................................................................................ 256
<ImageDirectory> ........................................................................................................................ 257
<includegroup> ........................................................................................................................... 257
caption= ................................................................................................................................ 258
external= ................................................................................................................................ 259
name= ................................................................................................................................... 260
<includetask> .............................................................................................................................. 261
caption= ................................................................................................................................ 261
external= ................................................................................................................................ 262
name= ................................................................................................................................... 263
<input> ........................................................................................................................................ 264
count= ................................................................................................................................... 264
format= .................................................................................................................................. 265
type= ..................................................................................................................................... 266
viii of ANSYS, Inc. and its subsidiaries and affiliates.
<inputfile> ................................................................................................................................... 267

id= ......................................................................................................................................... 267
name= ................................................................................................................................... 268
<inputFromActionOutput> ........................................................................................................... 269
action= ................................................................................................................................... 269
Name= ................................................................................................................................... 270
output= .................................................................................................................................. 271
<inputFromOperator> .................................................................................................................. 272
Name= ................................................................................................................................... 273
operator= ............................................................................................................................... 274
<inputgroup> .............................................................................................................................. 274
<Input> .................................................................................................................................. 275
<inputs> ...................................................................................................................................... 276
<InputGroup> ........................................................................................................................ 276
<inputValue> ............................................................................................................................... 277
Name= ................................................................................................................................... 277
<Interface> .................................................................................................................................. 278
<Callbacks> ............................................................................................................................ 279
<filter> ................................................................................................................................... 280
<GetPostCommands> ............................................................................................................ 281
<GetPreCommands> .............................................................................................................. 282
<GetSolveCommands> ........................................................................................................... 283
<GetToolTips> ........................................................................................................................ 284
<images> ............................................................................................................................... 285
<IsAnalysisValid> .................................................................................................................... 285
<OnActiveObjectChange> ...................................................................................................... 286
<OnAfterRemove> ................................................................................................................. 288
<OnAfterSolve> ...................................................................................................................... 289
<OnBeforeGeometryUpdate> ................................................................................................. 290
<OnBeforeSolve> ................................................................................................................... 291
<OnDraw> ............................................................................................................................. 293
<OnDraw2D> ......................................................................................................................... 294
<OnInit> ................................................................................................................................ 295
<OnLoad> .............................................................................................................................. 296
<OnMeshCleaned> ................................................................................................................. 297
<OnMeshGenerated> ............................................................................................................. 298
<OnPostFinished> .................................................................................................................. 299
<OnPostStarted> .................................................................................................................... 300
<OnReady> ............................................................................................................................ 301
<OnSave> .............................................................................................................................. 302
<OnTerminate> ...................................................................................................................... 303
<OnUnitsChanged> ................................................................................................................ 304
<Resume> .............................................................................................................................. 305
<Save> ................................................................................................................................... 306
<toolbar> ............................................................................................................................... 307
context= ................................................................................................................................ 308
<Layout> ...................................................................................................................................... 309
<Component> ........................................................................................................................ 309
name= ................................................................................................................................... 310
<Layout> ...................................................................................................................................... 311
of ANSYS, Inc. and its subsidiaries and affiliates. ix
<Component> ........................................................................................................................ 311

name= ................................................................................................................................... 312
<Layout> ...................................................................................................................................... 313
<Component> ........................................................................................................................ 313
name= ................................................................................................................................... 314
<Layout> ...................................................................................................................................... 315
<Component> ........................................................................................................................ 315
name= ................................................................................................................................... 316
<License> ..................................................................................................................................... 317
name= ................................................................................................................................... 317
<Licenses> ................................................................................................................................... 318
<License> ............................................................................................................................... 318
<Link> .......................................................................................................................................... 319
from= ..................................................................................................................................... 320
to= ......................................................................................................................................... 320
<Load> ........................................................................................................................................ 321
<Action> ................................................................................................................................ 323
<Attributes> ........................................................................................................................... 324
<Callbacks> ............................................................................................................................ 325
<CanAdd> .............................................................................................................................. 326
<CanDuplicate> ..................................................................................................................... 327
<CanRemove> ........................................................................................................................ 328
<GetCommands> ................................................................................................................... 329
<GetNodalValuesForDisplay> ................................................................................................. 330
<GetPreCommands> .............................................................................................................. 332
<IsValid> ................................................................................................................................ 334
<OnAdd> ............................................................................................................................... 335
<OnClearData> ...................................................................................................................... 339
<OnDrawBodyViews> ............................................................................................................. 340
<OnDuplicate> ....................................................................................................................... 341
<OnGenerate> ....................................................................................................................... 342
<OnGenerateData> ................................................................................................................ 343
<OnHide> .............................................................................................................................. 344
<OnInit> ................................................................................................................................ 345
<OnMigrate> .......................................................................................................................... 346
<OnReady> ............................................................................................................................ 347
<OnRemove> ......................................................................................................................... 348
<OnShow> ............................................................................................................................. 349
<OnSuppress> ....................................................................................................................... 350
<OnUnsuppress> ................................................................................................................... 351
<Property> ............................................................................................................................. 352
AffectsSolution= ..................................................................................................................... 352
caption= ................................................................................................................................ 353
class= ..................................................................................................................................... 354
color= .................................................................................................................................... 355
contextual= ............................................................................................................................ 356
icon= ...................................................................................................................................... 357
x of ANSYS, Inc. and its subsidiaries and affiliates.
IsLoad= .................................................................................................................................. 358

IsSupport= ............................................................................................................................. 359
name= ................................................................................................................................... 360
unit= ...................................................................................................................................... 361
version= ................................................................................................................................. 362
<nativepropertytable> ................................................................................................................. 362
<Attributes> ........................................................................................................................... 365
<Callbacks> ............................................................................................................................ 365
<GetValue> ............................................................................................................................ 366
<help> ................................................................................................................................... 367
<IsValid> ................................................................................................................................ 368
<IsVisible> .............................................................................................................................. 369
<OnActivate> ......................................................................................................................... 370
<OnAdd> ............................................................................................................................... 371
<OnApply> ............................................................................................................................ 373
<OnButtonClick> .................................................................................................................... 375
<OnCancel> ........................................................................................................................... 376
<OnDuplicate> ....................................................................................................................... 377
<OnHide> .............................................................................................................................. 378
<OnInit> ................................................................................................................................ 379
<OnJournalExecuting> ........................................................................................................... 380
<OnJournalRecording> .......................................................................................................... 381
<OnMigrate> .......................................................................................................................... 382
<OnRemove> ......................................................................................................................... 383
<OnShow> ............................................................................................................................. 384
<OnValidate> ......................................................................................................................... 385
<Property> ............................................................................................................................. 386
<SetValue> ............................................................................................................................. 386
<String2Value> ...................................................................................................................... 387
<Value2String> ...................................................................................................................... 388
allowempty= .......................................................................................................................... 389
caption= ................................................................................................................................ 390
class= ..................................................................................................................................... 391
control= ................................................................................................................................. 392
default= ................................................................................................................................. 393
display= ................................................................................................................................. 394
elementtype= ......................................................................................................................... 395
isparameter= .......................................................................................................................... 396
keytype= ................................................................................................................................ 397
name= ................................................................................................................................... 397
needupdate= ......................................................................................................................... 398
parameterizable= ................................................................................................................... 399
persistent= ............................................................................................................................. 400
readonly= ............................................................................................................................... 401
unit= ...................................................................................................................................... 402
valuetype= ............................................................................................................................. 403
visible= .................................................................................................................................. 404
visibleon= .............................................................................................................................. 405
<Object> ...................................................................................................................................... 406
<Action> ................................................................................................................................ 408
of ANSYS, Inc. and its subsidiaries and affiliates. xi
<Attributes> ........................................................................................................................... 409

<Callbacks> ............................................................................................................................ 409
<CanAdd> .............................................................................................................................. 410
<CanDuplicate> ..................................................................................................................... 411
<CanRemove> ........................................................................................................................ 412
<GetCommands> ................................................................................................................... 413
<GetNodalValuesForDisplay> ................................................................................................. 414
<GetPreCommands> .............................................................................................................. 416
<IsValid> ................................................................................................................................ 418
<OnAdd> ............................................................................................................................... 419
<OnClearData> ...................................................................................................................... 423
<OnDrawBodyViews> ............................................................................................................. 424
<OnDuplicate> ....................................................................................................................... 425
<OnGenerate> ....................................................................................................................... 426
<OnGenerateData> ................................................................................................................ 427
<OnHide> .............................................................................................................................. 428
<OnInit> ................................................................................................................................ 429
<OnMigrate> .......................................................................................................................... 430
<OnReady> ............................................................................................................................ 431
<OnRemove> ......................................................................................................................... 432
<OnShow> ............................................................................................................................. 433
<OnSuppress> ....................................................................................................................... 434
<OnUnsuppress> ................................................................................................................... 435
<Property> ............................................................................................................................. 436
<Target> ................................................................................................................................ 436
AffectsSolution= ..................................................................................................................... 437
caption= ................................................................................................................................ 438
class= ..................................................................................................................................... 439
color= .................................................................................................................................... 440
contextual= ............................................................................................................................ 441
icon= ...................................................................................................................................... 442
IsLoad= .................................................................................................................................. 443
IsSupport= ............................................................................................................................. 444
name= ................................................................................................................................... 444
unit= ...................................................................................................................................... 445
version= ................................................................................................................................. 446
<operator> ................................................................................................................................... 447
<InputValue> ......................................................................................................................... 448
Name= ................................................................................................................................... 448
Type= ..................................................................................................................................... 449
<Optimizer> ................................................................................................................................. 450
<Attributes> ........................................................................................................................... 454
<Callbacks> ............................................................................................................................ 455
<CanAdd> .............................................................................................................................. 456
<CanDuplicate> ..................................................................................................................... 457
<CanRemove> ........................................................................................................................ 458
<CanRun> .............................................................................................................................. 459
xii of ANSYS, Inc. and its subsidiaries and affiliates.
<Configuration> ..................................................................................................................... 460

<ConvergenceDescription> .................................................................................................... 461
<Description> ........................................................................................................................ 462
<InputParametersEdited> ....................................................................................................... 463
<IsValid> ................................................................................................................................ 464
<MethodPropertiesEdited> .................................................................................................... 465
<ObjectivesOrConstraintsEdited> ........................................................................................... 466
<OnAdd> ............................................................................................................................... 467
<OnClearData> ...................................................................................................................... 470
<OnCreate> ........................................................................................................................... 471
<OnDuplicate> ....................................................................................................................... 472
<OnGenerateData> ................................................................................................................ 473
<OnHide> .............................................................................................................................. 474
<OnInit> ................................................................................................................................ 475
<OnMigrate> .......................................................................................................................... 476
<OnReady> ............................................................................................................................ 477
<OnRelease> .......................................................................................................................... 478
<OnRemove> ......................................................................................................................... 479
<OnShow> ............................................................................................................................. 480
<OnSuppress> ....................................................................................................................... 481
<OnUnsuppress> ................................................................................................................... 482
<ParameterRelationshipsEdited> ............................................................................................ 483
<Property> ............................................................................................................................. 484
<QuickHelp> .......................................................................................................................... 484
<Status> ................................................................................................................................ 485
basedondirectoptimizationonly= ............................................................................................ 486
basedonresponsesurfaceonly= ............................................................................................... 487
caption= ................................................................................................................................ 488
class= ..................................................................................................................................... 489
constrainthandling= ............................................................................................................... 490
constraintimportance= ........................................................................................................... 491
constraintoninputparameter= ................................................................................................. 492
contextual= ............................................................................................................................ 493
convergencedata= .................................................................................................................. 494
equaltoconstraint= ................................................................................................................. 495
greaterthanconstraint= ........................................................................................................... 495
gridintervaloninputparameter= .............................................................................................. 496
historychartxaxistype= ........................................................................................................... 497
icon= ...................................................................................................................................... 498
insideboundsconstraint= ........................................................................................................ 499
lessthanconstraint= ................................................................................................................ 500
logfile= ................................................................................................................................... 501
maximizeobjective= ............................................................................................................... 502
maximumnumberofconstraints= ............................................................................................. 503
maximumnumberofdoublelistparameters= ............................................................................. 504
maximumnumberofdoubleparameters= ................................................................................. 505
maximumnumberofinputparameters= .................................................................................... 505
maximumnumberofintegerlistparameters= ............................................................................. 506
maximumnumberofobjectives= .............................................................................................. 507
minimizeobjective= ................................................................................................................ 508
of ANSYS, Inc. and its subsidiaries and affiliates. xiii
minimumnumberofconstraints= ............................................................................................. 509

minimumnumberofobjectives= .............................................................................................. 510
name= ................................................................................................................................... 511
objectiveimportance= ............................................................................................................ 512
objectiveoninputparameter= .................................................................................................. 513
parameterrelationship= .......................................................................................................... 514
seekobjective= ....................................................................................................................... 515
startingpointrequired= ........................................................................................................... 515
version= ................................................................................................................................. 516
<OrderableCallback> .................................................................................................................... 517
caninterrupt= ......................................................................................................................... 518
order= .................................................................................................................................... 519
<output> ..................................................................................................................................... 520
format= .................................................................................................................................. 520
type= ..................................................................................................................................... 521
<outputfile> ................................................................................................................................. 522
id= ......................................................................................................................................... 522
name= ................................................................................................................................... 523
<outputs> .................................................................................................................................... 524
<Output> ............................................................................................................................... 524
<Panel> ........................................................................................................................................ 525
<Callbacks> ............................................................................................................................ 526
<DialogProgressMonitorView> ............................................................................................... 526
<OnPanelHidden> .................................................................................................................. 527
<OnPanelInitialized> .............................................................................................................. 528
<OnPanelShown> .................................................................................................................. 529
class= ..................................................................................................................................... 530
layout= ................................................................................................................................... 531
name= ................................................................................................................................... 532
<PanelComponent> ..................................................................................................................... 533
<Attributes> ........................................................................................................................... 534
<Layout> ................................................................................................................................ 534
<layoutName> ....................................................................................................................... 535
BottomAttachment= .............................................................................................................. 536
BottomOffset= ....................................................................................................................... 537
ComponentType= .................................................................................................................. 538
CustomCSSFile= ..................................................................................................................... 539
CustomHTMLFile= .................................................................................................................. 539
CustomJSFile= ........................................................................................................................ 540
Height= .................................................................................................................................. 541
HeightType= .......................................................................................................................... 542
LeftAttachment= .................................................................................................................... 543
LeftOffset= ............................................................................................................................. 544
MaxHeight= ........................................................................................................................... 545
MaxWidth= ............................................................................................................................ 546
MinHeight= ............................................................................................................................ 547
MinWidth= ............................................................................................................................. 548
name= ................................................................................................................................... 549
RightAttachment= .................................................................................................................. 549
RightOffset= ........................................................................................................................... 550
TopAttachment= .................................................................................................................... 551
TopOffset= ............................................................................................................................. 552
xiv of ANSYS, Inc. and its subsidiaries and affiliates.
visible= .................................................................................................................................. 553

Width= ................................................................................................................................... 554
WidthType= ............................................................................................................................ 555
<parameter> ................................................................................................................................ 556
<Attributes> ........................................................................................................................... 557
<Callbacks> ............................................................................................................................ 558
<CanAdd> .............................................................................................................................. 559
<CanDuplicate> ..................................................................................................................... 560
<CanRemove> ........................................................................................................................ 561
<IsValid> ................................................................................................................................ 562
<OnAdd> ............................................................................................................................... 563
<OnClearData> ...................................................................................................................... 566
<OnDuplicate> ....................................................................................................................... 567
<OnGenerateData> ................................................................................................................ 568
<OnHide> .............................................................................................................................. 569
<OnInit> ................................................................................................................................ 570
<OnMigrate> .......................................................................................................................... 571
<OnReady> ............................................................................................................................ 572
<OnRemove> ......................................................................................................................... 573
<OnShow> ............................................................................................................................. 574
<OnSuppress> ....................................................................................................................... 575
<OnUnsuppress> ................................................................................................................... 576
<Property> ............................................................................................................................. 577
caption= ................................................................................................................................ 577
class= ..................................................................................................................................... 578
contextual= ............................................................................................................................ 579
control= ................................................................................................................................. 580
icon= ...................................................................................................................................... 581
name= ................................................................................................................................... 582
usage= ................................................................................................................................... 583
version= ................................................................................................................................. 584
<parameters> ............................................................................................................................... 585
<Parameter> .......................................................................................................................... 585
<platform> ................................................................................................................................... 586
name= ................................................................................................................................... 586
path= ..................................................................................................................................... 587
<Presentations> ........................................................................................................................... 588
<ScenePresentation> ............................................................................................................. 588
Name= ................................................................................................................................... 589
<ProductDataModelConverter> .................................................................................................... 590
<Callbacks> ............................................................................................................................ 590
<OnReadInput> ..................................................................................................................... 591
<OnSendBackData> ............................................................................................................... 592
<OnSendData> ...................................................................................................................... 593
<OnWriteInput> ..................................................................................................................... 594
<UserObjectConverter> .......................................................................................................... 595
dataModel= ............................................................................................................................ 596
product= ................................................................................................................................ 597
<ProductTask> ............................................................................................................................. 598
<DataModelInOut> ................................................................................................................ 598
of ANSYS, Inc. and its subsidiaries and affiliates. xv
caption= ................................................................................................................................ 599

name= ................................................................................................................................... 600
product= ................................................................................................................................ 601
<program> ................................................................................................................................... 602
<Argument> .......................................................................................................................... 602
<Platform> ............................................................................................................................. 603
<projectdata> .............................................................................................................................. 603
<DataEntity> .......................................................................................................................... 604
<property> .................................................................................................................................. 604
<Attributes> ........................................................................................................................... 607
<Callbacks> ............................................................................................................................ 607
<GetValue> ............................................................................................................................ 608
<help> ................................................................................................................................... 609
<IsValid> ................................................................................................................................ 610
<IsVisible> .............................................................................................................................. 611
<OnActivate> ......................................................................................................................... 612
<OnAdd> ............................................................................................................................... 613
<OnApply> ............................................................................................................................ 615
<OnButtonClick> .................................................................................................................... 617
<OnCancel> ........................................................................................................................... 618
<OnDuplicate> ....................................................................................................................... 619
<OnHide> .............................................................................................................................. 620
<OnInit> ................................................................................................................................ 621
<OnMigrate> .......................................................................................................................... 624
<OnRemove> ......................................................................................................................... 625
<OnShow> ............................................................................................................................. 626
<OnValidate> ......................................................................................................................... 627
<SetValue> ............................................................................................................................. 628
<String2Value> ...................................................................................................................... 629
<Value2String> ...................................................................................................................... 630
caption= ................................................................................................................................ 631
class= ..................................................................................................................................... 631
control= ................................................................................................................................. 632
default= ................................................................................................................................. 633
elementtype= ......................................................................................................................... 634
isparameter= .......................................................................................................................... 635
keytype= ................................................................................................................................ 636
name= ................................................................................................................................... 637
needupdate= ......................................................................................................................... 638
persistent= ............................................................................................................................. 640
readonly= ............................................................................................................................... 641
unit= ...................................................................................................................................... 642
valuetype= ............................................................................................................................. 643
visible= .................................................................................................................................. 643
visibleon= .............................................................................................................................. 644
<propertygroup> ......................................................................................................................... 645
<Attributes> ........................................................................................................................... 648
xvi of ANSYS, Inc. and its subsidiaries and affiliates.
<Callbacks> ............................................................................................................................ 648

<GetValue> ............................................................................................................................ 649
<help> ................................................................................................................................... 650
<IsValid> ................................................................................................................................ 651
<IsVisible> .............................................................................................................................. 652
<OnActivate> ......................................................................................................................... 653
<OnAdd> ............................................................................................................................... 654
<OnApply> ............................................................................................................................ 656
<OnButtonClick> .................................................................................................................... 658
<OnCancel> ........................................................................................................................... 659
<OnDuplicate> ....................................................................................................................... 660
<OnHide> .............................................................................................................................. 661
<OnInit> ................................................................................................................................ 662
<OnMigrate> .......................................................................................................................... 665
<OnRemove> ......................................................................................................................... 666
<OnShow> ............................................................................................................................. 667
<OnValidate> ......................................................................................................................... 668
<Property> ............................................................................................................................. 669
<SetValue> ............................................................................................................................. 669
<String2Value> ...................................................................................................................... 670
<Value2String> ...................................................................................................................... 671
caption= ................................................................................................................................ 672
class= ..................................................................................................................................... 673
control= ................................................................................................................................. 674
default= ................................................................................................................................. 675
display= ................................................................................................................................. 676
elementtype= ......................................................................................................................... 677
isparameter= .......................................................................................................................... 678
keytype= ................................................................................................................................ 679
name= ................................................................................................................................... 680
needupdate= ......................................................................................................................... 680
persistent= ............................................................................................................................. 682
readonly= ............................................................................................................................... 683
unit= ...................................................................................................................................... 684
valuetype= ............................................................................................................................. 685
visible= .................................................................................................................................. 686
visibleon= .............................................................................................................................. 687
<propertytable> ........................................................................................................................... 688
<Attributes> ........................................................................................................................... 690
<Callbacks> ............................................................................................................................ 691
<GetValue> ............................................................................................................................ 692
<help> ................................................................................................................................... 693
<IsValid> ................................................................................................................................ 693
<IsVisible> .............................................................................................................................. 694
<OnActivate> ......................................................................................................................... 695
<OnAdd> ............................................................................................................................... 696
of ANSYS, Inc. and its subsidiaries and affiliates. xvii
<OnApply> ............................................................................................................................ 698

<OnButtonClick> .................................................................................................................... 700
<OnCancel> ........................................................................................................................... 701
<OnDuplicate> ....................................................................................................................... 702
<OnHide> .............................................................................................................................. 703
<OnInit> ................................................................................................................................ 704
<OnMigrate> .......................................................................................................................... 707
<OnRemove> ......................................................................................................................... 708
<OnShow> ............................................................................................................................. 709
<OnValidate> ......................................................................................................................... 710
<Property> ............................................................................................................................. 711
<SetValue> ............................................................................................................................. 712
<String2Value> ...................................................................................................................... 713
<Value2String> ...................................................................................................................... 714
allowempty= .......................................................................................................................... 715
caption= ................................................................................................................................ 716
class= ..................................................................................................................................... 717
control= ................................................................................................................................. 718
default= ................................................................................................................................. 719
display= ................................................................................................................................. 719
elementtype= ......................................................................................................................... 720
isparameter= .......................................................................................................................... 721
keytype= ................................................................................................................................ 722
name= ................................................................................................................................... 723
needupdate= ......................................................................................................................... 724
persistent= ............................................................................................................................. 726
readonly= ............................................................................................................................... 727
unit= ...................................................................................................................................... 728
valuetype= ............................................................................................................................. 729
visible= .................................................................................................................................. 730
visibleon= .............................................................................................................................. 730
<Result> ....................................................................................................................................... 731
<Action> ................................................................................................................................ 733
<Attributes> ........................................................................................................................... 734
<Callbacks> ............................................................................................................................ 735
<CanAdd> .............................................................................................................................. 736
<CanDuplicate> ..................................................................................................................... 737
<CanRemove> ........................................................................................................................ 738
<Evaluate> ............................................................................................................................. 739
<GetFieldCount> .................................................................................................................... 740
<GetValue> ............................................................................................................................ 741
<IsValid> ................................................................................................................................ 742
<OnAdd> ............................................................................................................................... 743
<OnClearData> ...................................................................................................................... 746
<OnDuplicate> ....................................................................................................................... 747
<OnEndEval> ......................................................................................................................... 748
xviii of ANSYS, Inc. and its subsidiaries and affiliates.
<OnEndPost> ......................................................................................................................... 749

<OnGenerateData> ................................................................................................................ 750
<OnHide> .............................................................................................................................. 751
<OnInit> ................................................................................................................................ 752
<OnMigrate> .......................................................................................................................... 753
<OnReady> ............................................................................................................................ 754
<OnRemove> ......................................................................................................................... 755
<OnShow> ............................................................................................................................. 756
<OnStartEval> ........................................................................................................................ 757
<OnStartPost> ........................................................................................................................ 758
<OnSuppress> ....................................................................................................................... 759
<OnUnsuppress> ................................................................................................................... 760
<Property> ............................................................................................................................. 761
averaging= ............................................................................................................................. 761
caption= ................................................................................................................................ 762
class= ..................................................................................................................................... 763
contextual= ............................................................................................................................ 764
hasimaginary= ....................................................................................................................... 765
icon= ...................................................................................................................................... 766
iscontactresult= ...................................................................................................................... 767
location= ................................................................................................................................ 768
name= ................................................................................................................................... 769
timehistory= ........................................................................................................................... 769
type= ..................................................................................................................................... 770
unit= ...................................................................................................................................... 771
version= ................................................................................................................................. 772
<rsmjob> ..................................................................................................................................... 773
<Attributes> ........................................................................................................................... 775
<Callbacks> ............................................................................................................................ 776
<CanAdd> .............................................................................................................................. 776
<CanDuplicate> ..................................................................................................................... 777
<CanRemove> ........................................................................................................................ 778
<InputFile> ............................................................................................................................ 779
<IsValid> ................................................................................................................................ 780
<OnAdd> ............................................................................................................................... 781
<OnClearData> ...................................................................................................................... 784
<oncreatejobinput> ............................................................................................................... 785
<OnDuplicate> ....................................................................................................................... 786
<OnGenerateData> ................................................................................................................ 787
<OnHide> .............................................................................................................................. 788
<OnInit> ................................................................................................................................ 789
<onjobcancellation> .............................................................................................................. 790
<onjobreconnect> ................................................................................................................. 791
<onjobstatus> ........................................................................................................................ 792
<OnMigrate> .......................................................................................................................... 793
<OnReady> ............................................................................................................................ 794
<OnRemove> ......................................................................................................................... 795
<OnShow> ............................................................................................................................. 796
<OnSuppress> ....................................................................................................................... 797
<OnUnsuppress> ................................................................................................................... 798
of ANSYS, Inc. and its subsidiaries and affiliates. xix
<OutputFile> .......................................................................................................................... 799

<Program> ............................................................................................................................. 799
<Property> ............................................................................................................................. 800
caption= ................................................................................................................................ 801
class= ..................................................................................................................................... 802
contextual= ............................................................................................................................ 803
deletefiles= ............................................................................................................................ 803
icon= ...................................................................................................................................... 804
name= ................................................................................................................................... 805
version= ................................................................................................................................. 806
<Sampling> ................................................................................................................................. 807
<Attributes> ........................................................................................................................... 810
<Callbacks> ............................................................................................................................ 811
<CanAdd> .............................................................................................................................. 812
<CanDuplicate> ..................................................................................................................... 813
<CanRemove> ........................................................................................................................ 814
<CanRun> .............................................................................................................................. 815
<Configuration> ..................................................................................................................... 816
<Description> ........................................................................................................................ 817
<InputParametersEdited> ....................................................................................................... 818
<IsValid> ................................................................................................................................ 819
<MethodPropertiesEdited> .................................................................................................... 820
<OnAdd> ............................................................................................................................... 821
<OnClearData> ...................................................................................................................... 824
<OnCreate> ........................................................................................................................... 825
<OnDuplicate> ....................................................................................................................... 826
<OnGenerateData> ................................................................................................................ 827
<OnHide> .............................................................................................................................. 828
<OnInit> ................................................................................................................................ 829
<OnMigrate> .......................................................................................................................... 830
<OnReady> ............................................................................................................................ 831
<OnRelease> .......................................................................................................................... 832
<OnRemove> ......................................................................................................................... 833
<OnShow> ............................................................................................................................. 834
<OnSuppress> ....................................................................................................................... 835
<OnUnsuppress> ................................................................................................................... 836
<Property> ............................................................................................................................. 837
<QuickHelp> .......................................................................................................................... 837
<Status> ................................................................................................................................ 838
caption= ................................................................................................................................ 839
class= ..................................................................................................................................... 840
contextual= ............................................................................................................................ 841
CustomTable= ........................................................................................................................ 842
icon= ...................................................................................................................................... 843
logfile= ................................................................................................................................... 844
maximumnumberofdoublelistparameters= ............................................................................. 845
maximumnumberofdoubleparameters= ................................................................................. 846
maximumnumberofinputparameters= .................................................................................... 847
maximumnumberofintegerlistparameters= ............................................................................. 848
name= ................................................................................................................................... 848
xx of ANSYS, Inc. and its subsidiaries and affiliates.
version= ................................................................................................................................. 849

<Scene> ....................................................................................................................................... 850
<Callbacks> ............................................................................................................................ 851
<OnAdd> ............................................................................................................................... 852
<OnDelete> ........................................................................................................................... 853
<OnHighlight> ....................................................................................................................... 854
<OnUnhighlight> ................................................................................................................... 855
<OnUpdate> .......................................................................................................................... 856
allowHighlight= ...................................................................................................................... 857
userObject= ........................................................................................................................... 857
visibility= ................................................................................................................................ 858
<script> ....................................................................................................................................... 859
compiled= .............................................................................................................................. 860
src= ........................................................................................................................................ 861
<separator> ................................................................................................................................. 862
<simdata> .................................................................................................................................... 862
<Load> .................................................................................................................................. 862
<Udf> .................................................................................................................................... 863
context= ................................................................................................................................ 864
<Solver> ...................................................................................................................................... 865
<Attributes> ........................................................................................................................... 866
<Callbacks> ............................................................................................................................ 867
<CanAdd> .............................................................................................................................. 868
<CanDuplicate> ..................................................................................................................... 869
<CanRemove> ........................................................................................................................ 870
<GetFiles> .............................................................................................................................. 871
<GetReader> .......................................................................................................................... 872
<GetSteps> ............................................................................................................................ 873
<IsAnalysisValid> .................................................................................................................... 874
<IsValid> ................................................................................................................................ 875
<OnAdd> ............................................................................................................................... 876
<OnBeforeSolve> ................................................................................................................... 878
<OnCheckResults> ................................................................................................................. 880
<OnClearData> ...................................................................................................................... 881
<OnDuplicate> ....................................................................................................................... 882
<OnGenerateData> ................................................................................................................ 883
<OnHide> .............................................................................................................................. 884
<OnInit> ................................................................................................................................ 885
<OnMigrate> .......................................................................................................................... 886
<OnReady> ............................................................................................................................ 887
<OnRemove> ......................................................................................................................... 888
<OnShow> ............................................................................................................................. 889
<OnSolve> ............................................................................................................................. 890
<OnSuppress> ....................................................................................................................... 891
<OnUnsuppress> ................................................................................................................... 892
<OnWriteInputFile> ................................................................................................................ 893
<Property> ............................................................................................................................. 894
analysis= ................................................................................................................................ 894
caption= ................................................................................................................................ 895
class= ..................................................................................................................................... 896
of ANSYS, Inc. and its subsidiaries and affiliates. xxi
contextual= ............................................................................................................................ 897

evaluateFunctionLoads= ......................................................................................................... 898
icon= ...................................................................................................................................... 899
name= ................................................................................................................................... 900
physics= ................................................................................................................................. 901
toolbox= ................................................................................................................................ 902
version= ................................................................................................................................. 902
<StandardAction> ........................................................................................................................ 903
actionId= ................................................................................................................................ 904
caption= ................................................................................................................................ 905
name= ................................................................................................................................... 906
<Step> ......................................................................................................................................... 907
<Attributes> ........................................................................................................................... 908
<Callbacks> ............................................................................................................................ 909
<CanAdd> .............................................................................................................................. 910
<CanDuplicate> ..................................................................................................................... 911
<CanRemove> ........................................................................................................................ 912
<ComponentData> ................................................................................................................ 913
<ComponentStyle> ................................................................................................................ 913
<Description> ........................................................................................................................ 914
<IsValid> ................................................................................................................................ 915
<OnAdd> ............................................................................................................................... 916
<OnClearData> ...................................................................................................................... 919
<oncreate> ............................................................................................................................ 920
<OnDuplicate> ....................................................................................................................... 921
<OnGenerateData> ................................................................................................................ 922
<OnHide> .............................................................................................................................. 923
<OnInit> ................................................................................................................................ 924
<OnMigrate> .......................................................................................................................... 925
<OnReady> ............................................................................................................................ 926
<onrefresh> ........................................................................................................................... 927
<OnRemove> ......................................................................................................................... 928
<onreset> .............................................................................................................................. 929
<OnShow> ............................................................................................................................. 930
<OnSuppress> ....................................................................................................................... 931
<OnUnsuppress> ................................................................................................................... 932
<onupdate> ........................................................................................................................... 933
<Property> ............................................................................................................................. 934
caption= ................................................................................................................................ 934
class= ..................................................................................................................................... 935
Context= ................................................................................................................................ 936
contextual= ............................................................................................................................ 937
Enabled= ................................................................................................................................ 938
helpFile= ................................................................................................................................ 939
icon= ...................................................................................................................................... 940
Layout= .................................................................................................................................. 941
name= ................................................................................................................................... 942
version= ................................................................................................................................. 942
<Target> ...................................................................................................................................... 943
location= ................................................................................................................................ 944
xxii of ANSYS, Inc. and its subsidiaries and affiliates.
name= ................................................................................................................................... 945

type= ..................................................................................................................................... 946
<task> .......................................................................................................................................... 946
<Attributes> ........................................................................................................................... 948
<Callbacks> ............................................................................................................................ 949
<CanAdd> .............................................................................................................................. 950
<canconsumedata> ................................................................................................................ 951
<CanDuplicate> ..................................................................................................................... 952
<CanRemove> ........................................................................................................................ 953
<ContextMenus> .................................................................................................................... 954
<Inputs> ................................................................................................................................ 954
<IsValid> ................................................................................................................................ 955
<OnAdd> ............................................................................................................................... 956
<onclean> .............................................................................................................................. 959
<OnClearData> ...................................................................................................................... 960
<ondelete> ............................................................................................................................ 961
<OnDuplicate> ....................................................................................................................... 962
<onedit> ................................................................................................................................ 963
<OnGenerateData> ................................................................................................................ 964
<OnHide> .............................................................................................................................. 965
<OnInit> ................................................................................................................................ 966
<oninitialize> ......................................................................................................................... 967
<onload> ............................................................................................................................... 968
<OnMigrate> .......................................................................................................................... 969
<OnReady> ............................................................................................................................ 970
<onrefresh> ........................................................................................................................... 971
<OnRemove> ......................................................................................................................... 972
<onreport> ............................................................................................................................ 973
<onreset> .............................................................................................................................. 974
<OnShow> ............................................................................................................................. 975
<onstatus> ............................................................................................................................. 976
<OnSuppress> ....................................................................................................................... 977
<OnUnsuppress> ................................................................................................................... 978
<onupdate> ........................................................................................................................... 979
<Outputs> ............................................................................................................................. 980
<Parameters> ......................................................................................................................... 980
<Property> ............................................................................................................................. 981
<RsmJob> .............................................................................................................................. 982
caption= ................................................................................................................................ 982
class= ..................................................................................................................................... 983
contextual= ............................................................................................................................ 984
editicon= ................................................................................................................................ 985
enableGenericTransfer= .......................................................................................................... 986
icon= ...................................................................................................................................... 987
name= ................................................................................................................................... 988
version= ................................................................................................................................. 989
<task> .......................................................................................................................................... 990
Message= ............................................................................................................................... 990
Name= ................................................................................................................................... 991
Pct= ....................................................................................................................................... 992
of ANSYS, Inc. and its subsidiaries and affiliates. xxiii
<taskgroup> ................................................................................................................................ 993

<Attributes> ........................................................................................................................... 994
<Callbacks> ............................................................................................................................ 995
<CanAdd> .............................................................................................................................. 996
<CanDuplicate> ..................................................................................................................... 997
<CanRemove> ........................................................................................................................ 998
<IncludeGroup> ..................................................................................................................... 999
<IncludeTask> ........................................................................................................................ 999
<IsValid> .............................................................................................................................. 1000
<OnAdd> ............................................................................................................................. 1001
<OnAfterGeometryUpdate> ................................................................................................. 1002
<OnBodySuppressStateChange> .......................................................................................... 1003
<OnClearData> ..................................................................................................................... 1004
<OnDuplicate> ..................................................................................................................... 1005
<OnGenerateData> .............................................................................................................. 1006
<OnHide> ............................................................................................................................ 1007
<OnInit> ............................................................................................................................... 1008
<OnMigrate> ........................................................................................................................ 1009
<OnReady> .......................................................................................................................... 1010
<OnRemove> ....................................................................................................................... 1011
<OnShow> ........................................................................................................................... 1012
<OnSuppress> ...................................................................................................................... 1013
<OnUnsuppress> .................................................................................................................. 1014
<Property> ........................................................................................................................... 1015
abbreviation= ....................................................................................................................... 1015
caption= ............................................................................................................................... 1016
category= ............................................................................................................................. 1017
class= ................................................................................................................................... 1018
contextual= .......................................................................................................................... 1019
headertext= ......................................................................................................................... 1020
icon= .................................................................................................................................... 1021
isparametricgroup= .............................................................................................................. 1022
name= .................................................................................................................................. 1023
version= ............................................................................................................................... 1023
<taskgroups> ............................................................................................................................. 1024
<TaskGroup> ........................................................................................................................ 1025
<tasks> ...................................................................................................................................... 1025
<Task> .................................................................................................................................. 1026
<Templates> .............................................................................................................................. 1027
<ControlTemplate> .............................................................................................................. 1027
<toolbar> ................................................................................................................................... 1028
<Separator> ......................................................................................................................... 1028
caption= ............................................................................................................................... 1029
name= .................................................................................................................................. 1030
<udf> ......................................................................................................................................... 1031
folder= ................................................................................................................................. 1031
<UIDefinition> ............................................................................................................................ 1032
<ComponentDefinition> ...................................................................................................... 1032
<Layout> .............................................................................................................................. 1033
<UserDefinedTask> ..................................................................................................................... 1034
<Callbacks> .......................................................................................................................... 1034
<onUpdate> ......................................................................................................................... 1035
xxiv of ANSYS, Inc. and its subsidiaries and affiliates.
caption= ............................................................................................................................... 1036

name= .................................................................................................................................. 1037
<UserInputTask> ........................................................................................................................ 1038
<DataModelInOut> .............................................................................................................. 1038
caption= ............................................................................................................................... 1039
name= .................................................................................................................................. 1040
panel= .................................................................................................................................. 1041
<UserObject> ............................................................................................................................. 1042
<Attributes> ......................................................................................................................... 1043
<Callbacks> .......................................................................................................................... 1044
<CanAdd> ............................................................................................................................ 1044
<CanDuplicate> ................................................................................................................... 1045
<CanRemove> ...................................................................................................................... 1046
<IsValid> .............................................................................................................................. 1047
<OnAdd> ............................................................................................................................. 1048
<OnClearData> ..................................................................................................................... 1051
<OnDuplicate> ..................................................................................................................... 1052
<OnGenerateData> .............................................................................................................. 1053
<OnHide> ............................................................................................................................ 1054
<OnInit> ............................................................................................................................... 1055
<OnMigrate> ........................................................................................................................ 1056
<OnReady> .......................................................................................................................... 1057
<OnRemove> ....................................................................................................................... 1058
<OnShow> ........................................................................................................................... 1059
<OnSuppress> ...................................................................................................................... 1060
<OnUnsuppress> .................................................................................................................. 1061
<Property> ........................................................................................................................... 1062
basedonxmldefinition= ......................................................................................................... 1063
caption= ............................................................................................................................... 1064
cardinality= .......................................................................................................................... 1065
class= ................................................................................................................................... 1066
contextual= .......................................................................................................................... 1067
icon= .................................................................................................................................... 1068
name= .................................................................................................................................. 1069
parent= ................................................................................................................................ 1069
version= ............................................................................................................................... 1070
<UserObjectConverter> .............................................................................................................. 1071
<Callbacks> .......................................................................................................................... 1072
<OnReadInput> .................................................................................................................... 1073
<OnSendBackData> ............................................................................................................. 1074
<OnSendData> ..................................................................................................................... 1075
<OnWriteInput> ................................................................................................................... 1076
userObject= ......................................................................................................................... 1077
<Wizard> .................................................................................................................................... 1077
<Callbacks> .......................................................................................................................... 1078
<canstart> ............................................................................................................................ 1079
<Description> ...................................................................................................................... 1080
<Step> ................................................................................................................................. 1081
allowNavigation= ................................................................................................................. 1081
caption= ............................................................................................................................... 1082
of ANSYS, Inc. and its subsidiaries and affiliates. xxv
context= ............................................................................................................................... 1083

hidden= ............................................................................................................................... 1084
icon= .................................................................................................................................... 1085
layout= ................................................................................................................................. 1086
name= .................................................................................................................................. 1087
persistent= ........................................................................................................................... 1088
subContext= ......................................................................................................................... 1088
version= ............................................................................................................................... 1089
<Workflow> ................................................................................................................................ 1090
<Attributes> ......................................................................................................................... 1093
<Callbacks> .......................................................................................................................... 1093
<CanAdd> ............................................................................................................................ 1094
<CanDuplicate> ................................................................................................................... 1095
<CanRemove> ...................................................................................................................... 1096
<IsValid> .............................................................................................................................. 1097
<OnAdd> ............................................................................................................................. 1098
<onafterdesignpointchanged> ............................................................................................. 1099
<onaftertaskcanduplicate> ................................................................................................... 1101
<onaftertaskcanusetransfer> ................................................................................................ 1102
<onaftertaskcreation> .......................................................................................................... 1103
<onaftertaskdeletion> .......................................................................................................... 1104
<onaftertaskduplicate> ........................................................................................................ 1105
<onaftertaskpropertyretrieval> ............................................................................................. 1106
<onaftertaskrefresh> ............................................................................................................ 1107
<onaftertaskreset> ............................................................................................................... 1108
<onaftertasksourceschanged> .............................................................................................. 1109
<onaftertaskstatus> .............................................................................................................. 1110
<onaftertaskupdate> ............................................................................................................ 1111
<onbeforedesignpointchanged> .......................................................................................... 1112
<onbeforetaskcanduplicate> ................................................................................................ 1113
<onbeforetaskcanusetransfer> ............................................................................................. 1114
<onbeforetaskcreation> ....................................................................................................... 1115
<onbeforetaskdeletion> ....................................................................................................... 1116
<onbeforetaskduplicate> ...................................................................................................... 1117
<onbeforetaskpropertyretrieval> .......................................................................................... 1118
<onbeforetaskrefresh> ......................................................................................................... 1119
<onbeforetaskreset> ............................................................................................................ 1120
<onbeforetasksourceschanged> ........................................................................................... 1121
<onbeforetaskstatus> ........................................................................................................... 1122
<onbeforetaskupdate> ......................................................................................................... 1123
<OnClearData> ..................................................................................................................... 1125
<OnDuplicate> ..................................................................................................................... 1126
<OnGenerateData> .............................................................................................................. 1127
<OnHide> ............................................................................................................................ 1128
<OnInit> ............................................................................................................................... 1129
<OnMigrate> ........................................................................................................................ 1130
<OnReady> .......................................................................................................................... 1131
<OnRemove> ....................................................................................................................... 1132
<OnShow> ........................................................................................................................... 1133
<OnSuppress> ...................................................................................................................... 1134
xxvi of ANSYS, Inc. and its subsidiaries and affiliates.
<OnUnsuppress> .................................................................................................................. 1135

<Property> ........................................................................................................................... 1136
<TaskGroups> ...................................................................................................................... 1137
<Tasks> ................................................................................................................................ 1138
caption= ............................................................................................................................... 1138
class= ................................................................................................................................... 1139
context= ............................................................................................................................... 1140
contextual= .......................................................................................................................... 1141
icon= .................................................................................................................................... 1142
name= .................................................................................................................................. 1143
version= ............................................................................................................................... 1144
<Workflow> ................................................................................................................................ 1145
<ApplicationTaskLink> .......................................................................................................... 1145
<UserDefinedTask> ............................................................................................................... 1146
of ANSYS, Inc. and its subsidiaries and affiliates. xxvii
xxviii of ANSYS, Inc. and its subsidiaries and affiliates.
List of Tables
1. XML Tag Listing ......................................................................................................................................... 3
2. XML Tag Listing ......................................................................................................................................... 6
3. XML Tag Listing ....................................................................................................................................... 10
4. XML Tag Listing ....................................................................................................................................... 14
5. XML Tag Listing ....................................................................................................................................... 18
6. XML Tag Listing ....................................................................................................................................... 21
7. XML Tag Listing ....................................................................................................................................... 40
8. XML Tag Listing ....................................................................................................................................... 44
9. XML Tag Listing ....................................................................................................................................... 47
10. XML Tag Listing ..................................................................................................................................... 48
11. XML Tag Listing ..................................................................................................................................... 49
12. XML Tag Listing ..................................................................................................................................... 52
13. XML Tag Listing ..................................................................................................................................... 56
14. XML Tag Listing ..................................................................................................................................... 59
15. XML Tag Listing ..................................................................................................................................... 62
16. XML Tag Listing ..................................................................................................................................... 64
17. XML Tag Listing ..................................................................................................................................... 66
18. XML Tag Listing ..................................................................................................................................... 68
19. XML Tag Listing ..................................................................................................................................... 89
20. XML Tag Listing ..................................................................................................................................... 91
21. XML Tag Listing ..................................................................................................................................... 97
22. XML Tag Listing ................................................................................................................................... 100
23. XML Tag Listing ................................................................................................................................... 102
24. XML Tag Listing ................................................................................................................................... 103
25. XML Tag Listing ................................................................................................................................... 106
26. XML Tag Listing ................................................................................................................................... 107
27. XML Tag Listing ................................................................................................................................... 110
28. XML Tag Listing ................................................................................................................................... 119
29. XML Tag Listing ................................................................................................................................... 121
30. XML Tag Listing ................................................................................................................................... 149
31. XML Tag Listing ................................................................................................................................... 155
32. XML Tag Listing ................................................................................................................................... 163
33. XML Tag Listing ................................................................................................................................... 183
34. XML Tag Listing ................................................................................................................................... 211
35. XML Tag Listing ................................................................................................................................... 214
36. XML Tag Listing ................................................................................................................................... 216
37. XML Tag Listing ................................................................................................................................... 246
38. XML Tag Listing ................................................................................................................................... 247
39. XML Tag Listing ................................................................................................................................... 258
40. XML Tag Listing ................................................................................................................................... 261
41. XML Tag Listing ................................................................................................................................... 264
42. XML Tag Listing ................................................................................................................................... 267
43. XML Tag Listing ................................................................................................................................... 269
44. XML Tag Listing ................................................................................................................................... 272
45. XML Tag Listing ................................................................................................................................... 275
46. XML Tag Listing ................................................................................................................................... 276
47. XML Tag Listing ................................................................................................................................... 277
48. XML Tag Listing ................................................................................................................................... 278
49. XML Tag Listing ................................................................................................................................... 309
50. XML Tag Listing ................................................................................................................................... 311
of ANSYS, Inc. and its subsidiaries and affiliates. xxix
51. XML Tag Listing ................................................................................................................................... 313

52. XML Tag Listing ................................................................................................................................... 315
53. XML Tag Listing ................................................................................................................................... 317
54. XML Tag Listing ................................................................................................................................... 318
55. XML Tag Listing ................................................................................................................................... 319
56. XML Tag Listing ................................................................................................................................... 322
57. XML Tag Listing ................................................................................................................................... 363
58. XML Tag Listing ................................................................................................................................... 406
59. XML Tag Listing ................................................................................................................................... 447
60. XML Tag Listing ................................................................................................................................... 450
61. XML Tag Listing ................................................................................................................................... 518
62. XML Tag Listing ................................................................................................................................... 520
63. XML Tag Listing ................................................................................................................................... 522
64. XML Tag Listing ................................................................................................................................... 524
65. XML Tag Listing ................................................................................................................................... 525
66. XML Tag Listing ................................................................................................................................... 533
67. XML Tag Listing ................................................................................................................................... 556
68. XML Tag Listing ................................................................................................................................... 585
69. XML Tag Listing ................................................................................................................................... 586
70. XML Tag Listing ................................................................................................................................... 588
71. XML Tag Listing ................................................................................................................................... 590
72. XML Tag Listing ................................................................................................................................... 598
73. XML Tag Listing ................................................................................................................................... 602
74. XML Tag Listing ................................................................................................................................... 604
75. XML Tag Listing ................................................................................................................................... 605
76. XML Tag Listing ................................................................................................................................... 646
77. XML Tag Listing ................................................................................................................................... 688
78. XML Tag Listing ................................................................................................................................... 732
79. XML Tag Listing ................................................................................................................................... 773
80. XML Tag Listing ................................................................................................................................... 807
81. XML Tag Listing ................................................................................................................................... 851
82. XML Tag Listing ................................................................................................................................... 860
83. XML Tag Listing ................................................................................................................................... 862
84. XML Tag Listing ................................................................................................................................... 865
85. XML Tag Listing ................................................................................................................................... 904
86. XML Tag Listing ................................................................................................................................... 907
87. XML Tag Listing ................................................................................................................................... 944
88. XML Tag Listing ................................................................................................................................... 947
89. XML Tag Listing ................................................................................................................................... 990
90. XML Tag Listing ................................................................................................................................... 993
91. XML Tag Listing .................................................................................................................................. 1025
92. XML Tag Listing .................................................................................................................................. 1026
93. XML Tag Listing .................................................................................................................................. 1027
94. XML Tag Listing .................................................................................................................................. 1028
95. XML Tag Listing .................................................................................................................................. 1031
96. XML Tag Listing .................................................................................................................................. 1032
97. XML Tag Listing .................................................................................................................................. 1034
98. XML Tag Listing .................................................................................................................................. 1038
99. XML Tag Listing .................................................................................................................................. 1042
100. XML Tag Listing ................................................................................................................................ 1072
101. XML Tag Listing ................................................................................................................................ 1078
102. XML Tag Listing ................................................................................................................................ 1091
xxx of ANSYS, Inc. and its subsidiaries and affiliates.
103. XML Tag Listing ................................................................................................................................ 1145
of ANSYS, Inc. and its subsidiaries and affiliates. xxxi
xxxii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference
ACT XML Tags
Table 1: XML Tag Listing
<action> (p. 6) No details provided.

<ActionCallback> (p. 10) Class defining the action callback.
<actions> (p. 14) No details provided.
<ActionsView> (p. 17) Class defining a panel to be displayed in the
application.
<Application> (p. 20) Class defining a new application.
<argument> (p. 40) This class defines the Argument XML Tag.
<assembly> (p. 43) Class defining the assembly to be loaded.
<attributes> (p. 46) Class defining the set of attributes for the object.
<BrowserView> (p. 47) Class defining a panel to be displayed in the
application.
<Callback> (p. 48) No details provided.
<CallbackEvaluate> (p. 49) No details provided.
<CallbackGetCommands> (p. 51) Class providing the commands to add to the solver
input file.
<CallbackGetPostPreSolveCommands> (p. 56) Class collecting all commands to add to the solver
input file.
<CallbackOnActiveObjectChange> (p. 59) Callback that is invoked when the active object
changes.
<CallbackOnGenerate> (p. 62) No details provided.
<CallbackOnSolve> (p. 64) No details provided.
<Callbacks> (p. 66) Class specifying the callbacks that will invoke
functions from the IronPython extension script.
<Component> (p. 67) Class defining a new component in a layout.
<ComponentData> (p. 89) Class defining the data for the component.
<ComponentDefinition> (p. 90) Class defining the display of the component.
<ComponentStyle> (p. 97) Class defining the styles for the component.
<connectTo> (p. 99) No details provided.
<contextmenus> (p. 102) No details provided.
<ControlTemplate> (p. 103) Class defining a control template for the creation of
groups of properties.
<datamodel> (p. 106) No details provided.
<DataModel> (p. 107) Class defining a data model.
of ANSYS, Inc. and its subsidiaries and affiliates. 3
ACT XML Tags
<DataModelView> (p. 110) Class defining a panel to be displayed in the

application.
<DialogProgressMonitorView> (p. 119) No details provided.
<entity> (p. 121) Class defining a custom data entity definition based
on an ACT XML Extension file.
<entry> (p. 148) Class defining a drop-down menu within a toolbar.
<entry> (p. 155) Class defining a user-interface GUI operatio.
<Extension> (p. 163) Class defining an ACT extension.
<ExtensionObject> (p. 182) Class extending the extension object definition.
(Inherited from DesignXplorer SimEntity)
<FileToolbarView> (p. 211) Class defining a panel to be displayed in the
application.
<filter> (p. 213) Class defining a filter for the object. The filtering
mechanism itself is application specific.
<Geometry> (p. 216) Class defining a geometry feature.
<guid> (p. 246) Class defining a unique identifier for the extension.
<Image> (p. 247) No details provided.
<ImageDirectory> (p. 257) No details provided.
<includegroup> (p. 257) Class defining the include group tag (used by task
groups).
<includetask> (p. 261) Class defining the include task tag (used by task
groups).
<input> (p. 264) Class defining an input-level data connection
definition.
<inputfile> (p. 267) This class difines the InputFile XML Tag.
<inputFromActionOutput> (p. 269) No details provided.
<inputFromOperator> (p. 272) No details provided.
<inputgroup> (p. 274) Class defining the input group collections for a task.
<inputs> (p. 276) Class defining the inputs collection for a task.
<inputValue> (p. 277) No details provided.
<Interface> (p. 278) Class defining the user interface for the extension.
<Layout> (p. 309) No details provided.
<Layout> (p. 311) Class defining the a new panel layout.
<License> (p. 317) Class defining a license to be used in the execution
of an extension.
<Licenses> (p. 318) Class defining a licenses collection for the extension.
<Link> (p. 319) Class defining a new application task link.
<Load> (p. 321) Class defining a simulation load or boundary.
<nativepropertytable> (p. 362) Class encapsulating a list of child properties under
one table.
4 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object> (p. 406) Class defining an object.
<operator> (p. 447) No details provided.
<Optimizer> (p. 450) Class defining an optimizer.
<OrderableCallback> (p. 517) A callback that supports an order specification. Used
when multiple callbacks could apply to the same
entity, allowing a proper "sorting" of execution.
<output> (p. 520) Class defining an output-level data connection
definition.
<outputfile> (p. 522) This class defines the OutputFile XML Tag.
<outputs> (p. 524) Class defining the outputs collection for a task.
<Panel> (p. 525) Class defining a panel to be displayed in the
application.
<PanelComponent> (p. 533) No details provided.
<parameter> (p. 556) Class defining a single parameter definition for a task.
<parameters> (p. 585) Class defining the collection of task parameters.
<platform> (p. 586) This class defines the Platform XML Tag.
<Presentations> (p. 588) No details provided.
<ProductDataModelConverter> (p. 590) No details provided.
<ProductTask> (p. 598) Class defining a new user input application task.
<program> (p. 602) This class defines the Program XML Tag.
<projectdata> (p. 603) No details provided.
<property> (p. 604) Class defining a property of any user object.
<propertygroup> (p. 645) Class defining a collection of properties.
<propertytable> (p. 688) Class encapsulating a list of child properties under
one table.
<Result> (p. 731) Class defining a result.
<rsmjob> (p. 773) This class defines an rsm job.
<Sampling> (p. 807) Class defining a DesignXplorer Sampling.
<Scene> (p. 850) No details provided.
<script> (p. 859) Specifies the IronPython script referenced by the
extension.
<separator> (p. 862) Class defining the separator for items in a toolbar.
<simdata> (p. 862) Class defining a general section that stores all user
object definitions.
<Solver> (p. 865) Class specifying a third-party solver to be used in the
simulation.
<StandardAction> (p. 903) No details provided.
<Step> (p. 907) Class defining a step in a guided process a (wizard or
AIM custom template).
<Target> (p. 943) Class defining the target location for the object.
<task> (p. 946) Class defining a task that encapsulates a single
process or application.
ACT XML Tags
<task> (p. 990) No details provided.

<taskgroup> (p. 993) Class defining a collection of tasks.
<taskgroups> (p. 1024) Class defining the task groups collection.
<tasks> (p. 1025) Class defining the tasks collection.
<Templates> (p. 1027) Class defining a collection of control templates.
<toolbar> (p. 1028) Class defining a toolbar in the UI of the application.
<udf> (p. 1031) Specifies the UDF folder referenced by the extension.
<UIDefinition> (p. 1032) Class defining a set of interface layouts that can be
used for guided processes (wizards).
<UserDefinedTask> (p. 1034) Class defining a new application task.
<UserInputTask> (p. 1038) Class defining a new user input application task.
<UserObject> (p. 1042) Class defining a user object of the data model.
<UserObjectConverter> (p. 1071) No details provided.
<Wizard> (p. 1077) Class defining a guided process (a wizard or AIM
custom template) within the extension.
<Workflow> (p. 1090) Class defining the top-level workflow tag within an
ACT app.
<Workflow> (p. 1145) Class defining a new application workflow.
<action>
No details provided.
Remarks
None.
Examples
None.
Tag <ConnectTo> (p. 6) No details

provided.
Tag <InputValue> (p. 7) No details
provided.
Attribute Name= (p. 8) No details
provided.
Attribute Type= (p. 9) No details
provided.
<ConnectTo>
<action>
Type
Ansys_ACT_Core_XmlDataModel_Language_ConnectTo (p. 99)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Language_ConnectTo
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<InputValue>
Type
Ansys_ACT_Core_XmlDataModel_Language_InputValue (p. 277)
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Language_InputValue
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Name of the variable associated to this action.
Name
Name
DefaultValue
None.
DataDefinition
False
<action>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Type=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Type of the action.
Name
Type
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
ACT XML Tags
MappedValues
None.
Public
True
TypeId
<ActionCallback>
Class defining the action callback.
Remarks
None.
Examples
None.
Attribute caninterrupt= (p. 10) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)
Attribute caption= (p. 11) No details provided.
Attribute icon= (p. 12) No details provided.
Attribute name= (p. 13) Name of the action callback.
caninterrupt=
Specifies whether the callback can be cancelled/interrupted. (inherited from CallbackBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
<ActionCallback>
Name
caninterrupt
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<ActionCallback>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the action callback.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
<actions>
Remarks
None.
Examples
None.
Tag <Action> (p. 14) No details

provided.
Tag <Operator> (p. 15) No details
provided.
Attribute MainAction= (p. 16) No details
provided.
provided.
<Action>
Type
Ansys_ACT_Core_XmlDataModel_Language_Action (p. 6)
Remarks
None.
Examples
None.
<actions>
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Language_Action
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Operator>
Type
Ansys_ACT_Core_XmlDataModel_Language_Operator (p. 447)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Language_Operator
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
ACT XML Tags
TypeId
MainAction=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Action to execute when the workflow is executed.
Name
MainAction
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
<ActionsView>
Name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Name of the workflow.
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
<ActionsView>
Class defining a panel to be displayed in the application.
ACT XML Tags
Remarks
None.
Examples
None.
Tag <StandardAction> (p. 18) No details provided.

Attribute component= (p. 19) No details provided.
Attribute name= (p. 19) Name of the view. (inherited from
View)
<StandardAction>
Type
Ansys_ACT_Core_XmlDataModel_Application_StandardAction (p. 903)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<ActionsView>
component=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
component
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the view. (inherited from View)
ACT XML Tags
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Application>
Class defining a new application.
Remarks
The name of the application will be a new context available for customization.
<Application>
Examples
None.
Tag <actions> (p. 21) No details provided.

Tag <ApplicationWorkflow> (p. 22) Defines the workflow to be used by the application.
Tag <Callbacks> (p. 23) Specifies the callbacks that will invoke functions
from the IronPython extension script. (inherited
from BaseApplication)
Callback <canstart> (p. 24) Callback that is invoked to determine whether the
application can be started. (inherited from
BaseApplication)
Tag <DataModel> (p. 25) No details provided.
Tag <Description> (p. 25) Description of the application. (inherited from
BaseApplication)
Callback <OnApplicationFinished> (p. 26) Callback that is invoked after the application
finishes.
Callback <OnApplicationStarted> (p. 27) Callback that is invoked when the application starts.
Callback <OnBeforeProjectClosed> (p. 28) Callback that is invoked before a project is closed.
Callback <OnBeforeSave> (p. 29) Callback that is invoked before a project is saved.
Callback <OnProjectLoaded> (p. 30) Callback that is invoked when a project is loaded
or a new project started.
Tag <Panel> (p. 31) Defines one or more panels to be displayed in the
application.
Tag <Presentations> (p. 31) No details provided.
Tag <ProductDataModelConverter> (p. 32) No details provided.
Attribute caption= (p. 33) Caption of the application. (inherited from
BaseApplication)
Attribute class= (p. 34) Class name of the controller of the object.
Attribute context= (p. 35) Context or combination of contexts (separated
using '|'). (inherited from BaseApplication)
Attribute icon= (p. 35) Icon for the application. (inherited from
BaseApplication)
Attribute name= (p. 36) Name of the application. (inherited from
BaseApplication)
Attribute projectExtName= (p. 37) Project extension name for associated project files.
Attribute version= (p. 38) Major version of the application. (inherited from
BaseApplication)
Attribute WorkflowToStart= (p. 39) No details provided.
<actions>
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Language_Workflow (p. 14)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<ApplicationWorkflow>
Defines the workflow to be used by the application.
Type
Ansys_ACT_Core_XmlDataModel_Application_ApplicationWorkflow (p. 1145)
Remarks
None.
Examples
None.
<Application>
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script. (inherited from
BaseApplication)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 66)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
ACT XML Tags
TypeId
<canstart>
Callback that is invoked to determine whether the application can be started. (inherited from Base-
Application)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 48)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_string__bool_
Name
canstart
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
<Application>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<DataModel>
Type
Ansys_ACT_Core_XmlDataModel_Application_DataModel (p. 107)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_DataModel
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Description>
Description of the application. (inherited from BaseApplication)
Type
System_String
Remarks
None.
ACT XML Tags
Examples
None.
Details
Description
Description of the wizard.
ValueName
description
Name
Description
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute
<OnApplicationFinished>
Callback that is invoked after the application finishes.
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_Application_
Name
OnApplicationFinished
Public
True
Obsolete
False
<Application>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnApplicationStarted>
Callback that is invoked when the application starts.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnApplicationStarted
Public
True
Obsolete
False
ObsoleteMessage
None.
ACT XML Tags
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnBeforeProjectClosed>
Callback that is invoked before a project is closed.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnBeforeProjectClosed
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
<Application>
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnBeforeSave>
Callback that is invoked before a project is saved.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnBeforeSave
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
ACT XML Tags
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnProjectLoaded>
Callback that is invoked when a project is loaded or a new project started.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnProjectLoaded
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
<Application>
RealParent
Mandatory
False
TypeId
<Panel>
Defines one or more panels to be displayed in the application.
Type
Ansys_ACT_Core_XmlDataModel_Application_Panel (p. 525)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Presentations>
Type
Ansys_ACT_Core_XmlDataModel_Application_Presentations (p. 588)
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<ProductDataModelConverter>
Type
Ansys_ACT_Core_XmlDataModel_Application_ProductDataModelConverter (p. 590)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
<Application>
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Caption of the application. (inherited from BaseApplication)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
caption
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
ACT XML Tags
Description
None.
TypeId
class=
Class name of the controller of the object.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
class
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Application>
context=
Context or combination of contexts (separated using '|'). (inherited from BaseApplication)
Type
System_String_ARRAY_
Remarks
This block will be taken into account only for the specified context(s).
Examples
None.
Details
Name
context
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Icon for the application. (inherited from BaseApplication)
ACT XML Tags
Type
System_String
Remarks
None.
Examples
None.
Details
Name
icon
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the application. (inherited from BaseApplication)
Type
System_String
<Application>
Remarks
None.
Examples
None.
Details
Name
name
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
projectExtName=
Project extension name for associated project files.
Type
System_String
Remarks
None.
ACT XML Tags
Examples
None.
Details
Name
projectExtName
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Major version of the application. (inherited from BaseApplication)
Type
System_Int32
Remarks
None.
Examples
None.
<Application>
Details
Name
version
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
WorkflowToStart=
Type
System_String
Remarks
None.
Examples
None.
Details
Name
WorkflowToStart
ACT XML Tags
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<argument>
This class defines the Argument XML Tag.
Remarks
None.
Examples
None.
Attribute name= (p. 40) The argument name.

Attribute separator= (p. 41) The argument-value
separator.
Attribute value= (p. 42) The argument value.
name=
The argument name.
<argument>
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
name
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
separator=
The argument-value separator.
Type
System_String
ACT XML Tags
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
separator
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
value=
The argument value.
Type
System_String
Remarks
None.
<assembly>
Examples
None.
Details
DefaultValue
None.
Name
value
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<assembly>
Class defining the assembly to be loaded.
Remarks
This tag is typically used to import a specific namespace from a C# dll.
Examples
Example 1:
<assembly src="CSharp.dll" namespace="CSharp" />
ACT XML Tags
Attribute context= (p. 44) Context or combination of contexts (separated using '|') for the
import.
Attribute namespace= (p. 45) Namespace to import.
Attribute src= (p. 46) Name of the dll file to import.
context=
Context or combination of contexts (separated using '|') for the import.
Type
System_String
Remarks
This block will be taken into account only for specified context(s).
Examples
None.
Details
Mandatory
False
Name
context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
<assembly>
TypeId
namespace=
Namespace to import.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
namespace
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
src=
Name of the dll file to import.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
src
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<attributes>
Class defining the set of attributes for the object.
<BrowserView>
Remarks
None.
Examples
None.
<BrowserView>
Remarks
None.
Examples
None.

View)
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
ACT XML Tags
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Callback>
Remarks
None.
Examples
None.
caninterrupt=
Type
System_Boolean
Remarks
None.
<CallbackEvaluate>
Examples
None.
Details
Mandatory
False
Name
caninterrupt
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<CallbackEvaluate>
Remarks
None.
Examples
None.
ACT XML Tags
Attribute InvokeUIThread= (p. 51) Invoke this callback on UIThread or not.
caninterrupt=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caninterrupt
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<CallbackGetCommands>
InvokeUIThread=
Invoke this callback on UIThread or not.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
InvokeUIThread
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Class providing the commands to add to the solver input file.
ACT XML Tags
Remarks
Use the location attribute to specifiy the execution of the callback. Options include: -init -pre -post -
solve -preload
Examples
None.
Attribute location= (p. 54) Location of the call.
Attribute order= (p. 55) Order of the call.
caninterrupt=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caninterrupt
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
InvokeUIThread=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
InvokeUIThread
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
location=
Location of the call.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
location
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
order=
Order of the call.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
order
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
<CallbackGetPostPreSolveCommands>
Class collecting all commands to add to the solver input file.
Remarks
None.
Examples
None.
Attribute order= (p. 57) Order of the call.
Attribute timedependent= (p. 58) Specifies if the callback will be called for each step.
caninterrupt=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caninterrupt
DefaultValue
False
DataDefinition
False
<CallbackGetPostPreSolveCommands>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
order=
Order of the call.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
order
DefaultValue
1
DataDefinition
False
AllowedValues
None.
MultipleValue
False
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
timedependent=
Specifies if the callback will be called for each step.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
timedependent
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
<CallbackOnActiveObjectChange>
Description
None.
TypeId
Callback that is invoked when the active object changes.
Remarks
None.
Examples
None.
Attribute name= (p. 60) The name filter.
Attribute type= (p. 61) The type filter.
caninterrupt=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Name
caninterrupt
ACT XML Tags
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
The name filter.
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
name
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
type=
The type filter.
Type
Ansys_ACT_Interfaces_UserObject_ObjectTypeEnum
Remarks
None.
Examples
None.
Details
DefaultValue
Unknown
Name
type
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
<CallbackOnGenerate>
Remarks
None.
Examples
None.
caninterrupt=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
<CallbackOnGenerate>
Name
caninterrupt
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
InvokeUIThread=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
InvokeUIThread
DefaultValue
True
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<CallbackOnSolve>
Remarks
None.
Examples
None.
caninterrupt=
Type
System_Boolean
Remarks
None.
<CallbackOnSolve>
Examples
None.
Details
Mandatory
False
Name
caninterrupt
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
InvokeUIThread=
Type
System_Boolean
Remarks
None.
Examples
None.
ACT XML Tags
Details
Mandatory
False
Name
InvokeUIThread
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Callbacks>
Class specifying the callbacks that will invoke functions from the IronPython extension script.
Remarks
The <callbacks> element and its children specify the Python functions that are invoked based on system-
and user-generated events.
Examples
None.
Tag <Callback> (p. 67) No details

provided.
<Component>
<Callback>
Type
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Callback
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Component>
Class defining a new component in a layout.
Remarks
None.
ACT XML Tags
Examples
None.
Tag <Attributes> (p. 68) Defines the set of attributes for the
component.
Attribute BottomAttachment= (p. 69) Bottom attachment of the layout.
Attribute BottomOffset= (p. 70) Bottom offset related to the bottom
attachment.
Attribute ComponentType= (p. 71) Type of the component for the component.
Attribute CustomCSSFile= (p. 72) Custom css file for the component layout.
Attribute CustomHTMLFile= (p. 73) Custom html file for the component layout.
Attribute CustomJSFile= (p. 74) Custom jscript file for the component
layout.
Attribute Height= (p. 74) Height value for the component.
Attribute HeightType= (p. 75) Height type for the component.
Attribute LeftAttachment= (p. 76) Left attachment of the layout.
Attribute LeftOffset= (p. 77) Left offset related to the left attachment.
Attribute MaxHeight= (p. 78) Maximum height for the component.
Attribute MaxWidth= (p. 79) Maximum width for the component.
Attribute MinHeight= (p. 80) Minimum height for the component.
Attribute MinWidth= (p. 81) Minimum width for the component.
Attribute name= (p. 82) Name of the component.
Attribute RightAttachment= (p. 83) Right attachment of the layout.
Attribute RightOffset= (p. 84) Right offset related to the right
attachment.
Attribute TopAttachment= (p. 84) Top attachment of the layout.
Attribute TopOffset= (p. 85) Top offset related to the top attachment.
Attribute visible= (p. 86) Initial visibility of the component.
Attribute Width= (p. 87) Width value for the component.
Attribute WidthType= (p. 88) Width type for the component.
<Attributes>
Defines the set of attributes for the component.
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 46)
Remarks
None.
<Component>
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
BottomAttachment=
Bottom attachment of the layout.
Type
System_String
Remarks
The value can be the name of a component or "" for the border.
Examples
None.
Details
Name
BottomAttachment
Mandatory
False
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
BottomOffset=
Bottom offset related to the bottom attachment.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
BottomOffset
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<Component>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ComponentType=
Type of the component for the component.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
ComponentType
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
CustomCSSFile=
Custom css file for the component layout.
Type
System_String
Remarks
This file will be taken in place of the standard one associated to the component.
Examples
None.
Details
Name
CustomCSSFile
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
<Component>
TypeId
CustomHTMLFile=
Custom html file for the component layout.
Type
System_String
Remarks
Examples
None.
Details
Name
CustomHTMLFile
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
CustomJSFile=
Custom jscript file for the component layout.
Type
System_String
Remarks
Examples
None.
Details
Name
CustomJSFile
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Height=
Height value for the component.
<Component>
Type
System_Single
Remarks
None.
Examples
None.
Details
Name
Height
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
HeightType=
Height type for the component.
Type
Ansys_ACT_Interfaces_UserInterface_ComponentLengthType
ACT XML Tags
Remarks
None.
Examples
None.
Details
Name
HeightType
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
LeftAttachment=
Left attachment of the layout.
Type
System_String
Remarks
<Component>
Examples
None.
Details
Name
LeftAttachment
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
LeftOffset=
Left offset related to the left attachment.
Type
System_Int32
Remarks
None.
Examples
None.
ACT XML Tags
Details
Name
LeftOffset
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
MaxHeight=
Maximum height for the component.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
MaxHeight
<Component>
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
MaxWidth=
Maximum width for the component.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
MaxWidth
Mandatory
False
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
MinHeight=
Minimum height for the component.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
MinHeight
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<Component>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
MinWidth=
Minimum width for the component.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
MinWidth
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
name=
Name of the component.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
<Component>
TypeId
RightAttachment=
Right attachment of the layout.
Type
System_String
Remarks
Examples
None.
Details
Name
RightAttachment
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
RightOffset=
Right offset related to the right attachment.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
RightOffset
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
TopAttachment=
Top attachment of the layout.
<Component>
Type
System_String
Remarks
Examples
None.
Details
Name
TopAttachment
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
TopOffset=
Top offset related to the top attachment.
Type
System_Int32
ACT XML Tags
Remarks
None.
Examples
None.
Details
Name
TopOffset
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
visible=
Initial visibility of the component.
Type
System_Boolean
Remarks
None.
<Component>
Examples
None.
Details
Name
visible
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
Width=
Width value for the component.
Type
System_Single
Remarks
None.
Examples
None.
ACT XML Tags
Details
Name
Width
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
WidthType=
Width type for the component.
Type
Remarks
None.
Examples
None.
Details
Name
WidthType
<ComponentData>
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<ComponentData>
Class defining the data for the component.
Remarks
None.
Examples
None.
Attribute component= (p. 89) No details

provided.
component=
Type
System_String
ACT XML Tags
Remarks
None.
Examples
None.
Details
Name
component
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<ComponentDefinition>
Class defining the display of the component.
Remarks
None.
Examples
None.
Attribute Class= (p. 91) Class to control this component.

Attribute CSSFile= (p. 92) Default CSS file to use for this component.
Attribute DataModelClass= (p. 93) Class type that describes the data model of the
component
Attribute Directory= (p. 94) Directory where are located HTML, CSS and JS files
Attribute HTMLFile= (p. 94) Default HTML file to use for this component.
Attribute JSFile= (p. 95) Default JS file to use for this component.
Attribute Name= (p. 96) Name of the component definition.
Class=
Class to control this component.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
Class
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
CSSFile=
Default CSS file to use for this component.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
CSSFile
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
DataModelClass=
Class type that describes the data model of the component
Type
System_String
Remarks
None.
Examples
None.
Details
Name
DataModelClass
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
Directory=
Directory where are located HTML, CSS and JS files
Type
System_String
Remarks
By default it is the directory of the extension if defined in an extension and "...ACT/html" if not.
Examples
None.
Details
Name
Directory
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
HTMLFile=
Default HTML file to use for this component.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
HTMLFile
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
JSFile=
Default JS file to use for this component.
Type
System_String
ACT XML Tags
Remarks
None.
Examples
None.
Details
Name
JSFile
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Name=
Name of the component definition.
Type
System_String
Remarks
This will identify the component type.
<ComponentStyle>
Examples
None.
Details
Name
Name
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<ComponentStyle>
Class defining the styles for the component.
Remarks
None.
Examples
None.
Attribute component= (p. 98) Name of the component for which styles are being
defined.
ACT XML Tags
Attribute filter= (p. 99) Filter for the component styles.
component=
Name of the component for which styles are being defined.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
component
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<connectTo>
filter=
Filter for the component styles.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
filter
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<connectTo>
ACT XML Tags
Remarks
None.
Examples
None.
Attribute action= (p. 100) No details

provided.
Attribute event= (p. 101) No details
provided.
action=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Action to connect to.
Name
action
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<connectTo>
MultipleValue
False
MappedValues
None.
Public
True
TypeId
event=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Event to connect to.
Name
event
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
TypeId
<contextmenus>
Remarks
None.
Examples
None.
Tag <UIEntry> (p. 102) No details

provided.
<UIEntry>
Type
Ansys_ACT_Core_XmlDataModel_UIEntry (p. 155)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_UIEntry
MinOccurence
0
MaxOccurence
-1
<ControlTemplate>
RealParent
None.
Mandatory
False
TypeId
<ControlTemplate>
Class defining a control template for the creation of groups of properties.
Remarks
None.
Examples
None.
Tag <Property> (p. 103) No details provided.

Attribute name= (p. 104) Name of the control
template.
Attribute version= (p. 105) Version of the control
template.
<Property>
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 604)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
ACT XML Tags
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
name=
Name of the control template.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
DefaultValue
None.
Name
name
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<ControlTemplate>
Public
True
Description
None.
TypeId
version=
Version of the control template.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
DefaultValue
1
Name
version
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
ACT XML Tags
TypeId
<datamodel>
Remarks
None.
Examples
None.
Attribute name= (p. 106) The name of the data

model.
name=
The name of the data model.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
name
DefaultValue
None.
<DataModel>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
<DataModel>
Class defining a data model.
Remarks
None.
Examples
None.
Tag <UserObject> (p. 107) No details

provided.
Attribute icon= (p. 108) Icon of the data
model.
Attribute name= (p. 109) Name of the data
model.
<UserObject>
Type
Ansys_ACT_Core_XmlDataModel_Application_UserObject (p. 1042)
Remarks
None.
ACT XML Tags
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_UserObject
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
icon=
Icon of the data model.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
<DataModel>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the data model.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<DataModelView>
Remarks
None.
Examples
None.
Attribute chartComponent= (p. 110) No details provided.

Attribute dataModel= (p. 111) No details provided.
Attribute imageComponent= (p. 112) No details provided.
View)
Attribute presentation= (p. 114) No details provided.
Attribute propertiesComponent= (p. 115) No details provided.
Attribute sceneComponent= (p. 116) No details provided.
Attribute tabularComponent= (p. 117) No details provided.
Attribute treeComponent= (p. 118) No details provided.
chartComponent=
Type
System_String
<DataModelView>
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
chartComponent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
dataModel=
Type
System_String
Remarks
None.
ACT XML Tags
Examples
None.
Details
Mandatory
True
Name
dataModel
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
imageComponent=
Type
System_String
Remarks
None.
Examples
None.
<DataModelView>
Details
Mandatory
False
Name
imageComponent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
ACT XML Tags
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
presentation=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
presentation
DefaultValue
None.
<DataModelView>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
propertiesComponent=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
propertiesComponent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
sceneComponent=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
sceneComponent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<DataModelView>
Public
True
Description
None.
TypeId
tabularComponent=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
tabularComponent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
ACT XML Tags
TypeId
treeComponent=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
treeComponent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<DialogProgressMonitorView>
Remarks
None.
Examples
None.
Tag <task> (p. 119) No details provided.

View)
<task>
Type
Ansys_ACT_Core_XmlDataModel_Application_ProgressMonitorTask (p. 990)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
ACT XML Tags
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<entity>
<entity>
Class defining a custom data entity definition based on an ACT XML Extension file.
Remarks
None.
Examples
None.
Tag <Attributes> (p. 122) No details provided. (inherited from SimEntity)

Tag <Callbacks> (p. 123) No details provided. (inherited from SimEntity)
Callback <CanAdd> (p. 123) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <CanDuplicate> (p. 124) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 125) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Callback <IsValid> (p. 126) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 127) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 128) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 129) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 130) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 131) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 132) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 133) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 134) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 135) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 136) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 137) Callback that is invoked when the object is
removed. (inherited from SimEntity)
ACT XML Tags
Callback <OnShow> (p. 138) Callback that is invoked when the object is shown.
Callback <OnSuppress> (p. 139) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 140) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 141) No details provided. (inherited from SimEntity)
Attribute caption= (p. 142) Caption of the object. (inherited from SimEntity)
Attribute contextual= (p. 144) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute datatype= (p. 145) Data type representing the schematic-exposed
type for which this data entity represents.
Attribute icon= (p. 146) Icon for the object. (inherited from SimEntity)
Attribute name= (p. 147) Name of the object. (inherited from SimEntity)
Attribute version= (p. 148) Version of the object. (inherited from SimEntity)
<Attributes>
No details provided. (inherited from SimEntity)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
<entity>
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
<entity>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
<entity>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
ACT XML Tags
Remarks
This callback is not invoked when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
<entity>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
<entity>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
<entity>
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Type
<entity>
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Type
ACT XML Tags
Remarks
It enables the migration of data from the old saved object to the new one.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
Type
<entity>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
<entity>
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
<entity>
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Property>
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Caption of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
caption
<entity>
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Class name of the controller of the object. (inherited from SimEntity)
Type
System_String
Remarks
The constructor of the class referenced by this attribute takes two arguments:
• The ExtAPI variable (of type IMechanicalExtAPI)
• The associated load (of type IUserLoad)
Examples
None.
Details
DefaultValue
None.
Name
class
ACT XML Tags
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Indicates whether the object has to be displayed in the contextual menu. (inherited from SimEntity)
Type
System_Boolean
Remarks
By default, the contextual flag is true for "load", "result" and "object".
Examples
None.
Details
DefaultValue
True
Name
contextual
Mandatory
False
DataDefinition
False
<entity>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
datatype=
Data type representing the schematic-exposed type for which this data entity represents.
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
datatype
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Icon for the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
icon
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
<entity>
Description
None.
TypeId
name=
Name of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
name
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
version=
Version of the object. (inherited from SimEntity)
Type
System_Int32
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
version
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<entry>
Class defining a drop-down menu within a toolbar.
<entry>
Remarks
To create a drop-down menu inside a toolbar, an entry has to be created inside another entry.
Examples
None.
Tag <Callbacks> (p. 149) Specifies the callbacks that will invoke functions from the IronPython
extension script.
Tag <Entry> (p. 150) No details provided.
Callback <OnClick> (p. 150) Callback that is invoked to return when the object is clicked.
Attribute caption= (p. 151) Caption of the entry.
Attribute Icon= (p. 152) Icon of the entry.
Attribute name= (p. 153) Name of the entry.
Attribute userobject= (p. 154) Related user object name.
<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script.
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
ACT XML Tags
Mandatory
False
TypeId
<Entry>
Type
Ansys_ACT_Core_XmlDataModel_Entry (p. 148)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Entry
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<OnClick>
Callback that is invoked to return when the object is clicked.
Type
<entry>
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IDataModelObject_
Name
OnClick
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
caption=
Caption of the entry.
Type
System_String
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Icon=
Icon of the entry.
Type
System_String
Remarks
None.
<entry>
Examples
None.
Details
Mandatory
False
Name
Icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the entry.
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
userobject=
Related user object name.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
<entry>
Name
userobject
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<entry>
Class defining a user-interface GUI operatio.
Remarks
None.
Examples
None.
Tag <Callbacks> (p. 156) Callbacks

Callback <onclick> (p. 156) Callback that is invoked on click.
Attribute caption= (p. 157) Display text of GUI operation.
Attribute icon= (p. 158) Icon for the object.
Attribute name= (p. 159) Name of GUI operation.
Attribute priority= (p. 160) UI-level priority (for grouping and ordering
purposes)
Attribute type= (p. 161) Type of GUI operation.
ACT XML Tags
Attribute version= (p. 162) Version of GUI operation...for backwards

compatiblity
<Callbacks>
Callbacks
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<onclick>
Callback that is invoked on click.
Type
Remarks
None.
<entry>
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onclick
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
caption=
Display text of GUI operation.
Type
System_String
Remarks
None.
ACT XML Tags
Examples
None.
Details
Name
caption
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Icon for the object.
Type
System_String
Remarks
None.
Examples
None.
<entry>
Details
Name
icon
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of GUI operation.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
ACT XML Tags
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
priority=
UI-level priority (for grouping and ordering purposes)
Type
System_Single
Remarks
None.
Examples
None.
Details
Name
priority
Mandatory
False
DefaultValue
None.
<entry>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
type=
Type of GUI operation.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
type
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Version of GUI operation...for backwards compatiblity
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
version
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<Extension>
Public
True
Description
None.
TypeId
<Extension>
Class defining an ACT extension.
Remarks
This is the base tag or "root" element under which all other tags/elements fall.
Examples
None.
Tag <Application> (p. 164) Defines one or more ACT applications that will be posted to
the ANSYS App Store.
Tag <appStoreId> (p. 165) Defines a unique identifier for the ACT application, to be used
in the ANSYS App Store.
Tag <assembly> (p. 165) Defines one or more assemblies to be loaded.
Tag <author> (p. 166) Defines the author of the extension.
Tag <description> (p. 167) Defines the description of the extension.
Tag <Guid> (p. 167) Defines a unique identifier for the extension.
Tag <ImageDirectory> (p. 168) Add a folder to find images.
Tag <Interface> (p. 169) Defines one or more the user interfaces for the extension.
Tag <Licenses> (p. 169) Defines a licenses collection for the extension.
Tag <script> (p. 170) Specifies one or more IronPython scripts referenced by the
extension.
Tag <simdata> (p. 171) Defines one or more general sections that store all user object
definitions.
Tag <Templates> (p. 171) Defines a collection of control templates for the extension.
Tag <UIDefinition> (p. 172) Defines one or more user interfaces for the extension.
Tag <Wizard> (p. 173) Defines one or more wizards within the extension.
Tag <Workflow> (p. 173) Defines one or more user-defined custom workflows composed
of tasks and task groups.
Attribute debug= (p. 174) To start this extension in debug mode if in scripted mode.
Attribute icon= (p. 175) Icon for the extension.
ACT XML Tags
Attribute isNative= (p. 176) Specifies if the extension is native, in that case migration
messages are ignored.
Attribute loadAsDefault= (p. 177) Specifies if the extension should be loaded automatically.
Attribute masked= (p. 178) Specifies if the extension should be loaded automatically, but
hidden in the Extension Manager.
Attribute minorversion= (p. 179) Minor version of the extension.
Attribute name= (p. 180) Name of the extension.
Attribute ReadPythonFiles= (p. 181) Primarly used by the AppBuilder to not read the python file
but used file that are already read and modified. ! Not Public !
Attribute version= (p. 181) Major version of the extension.
<Application>
Defines one or more ACT applications that will be posted to the ANSYS App Store.
Type
Ansys_ACT_Core_XmlDataModel_Application_CustomApplication (p. 20)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Extension>
<appStoreId>
Defines a unique identifier for the ACT application, to be used in the ANSYS App Store.
Type
System_String
Remarks
None.
Examples
None.
Details
Description
Unique identifier of the application for the ANSYS App Store. The format must be: author_shortname.
Name
appStoreId
ValueName
appStoreId
Public
True
TypeId
<assembly>
Defines one or more assemblies to be loaded.
Type
Ansys_ACT_Core_XmlDataModel_Assembly (p. 43)
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<author>
Defines the author of the extension.
Type
System_String
Remarks
None.
Examples
None.
Details
Description
Author of the extension.
Name
author
ValueName
authorName
Public
True
TypeId
<Extension>
<description>
Defines the description of the extension.
Type
System_String
Remarks
None.
Examples
None.
Details
Description
Description of the extension.
Name
description
ValueName
description
Public
True
TypeId
<Guid>
Defines a unique identifier for the extension.
Type
Ansys_ACT_Core_XmlDataModel_Guid (p. 246)
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<ImageDirectory>
Add a folder to find images.
Type
Ansys_ACT_Core_XmlDataModel_ImageDirectory (p. 257)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
<Extension>
TypeId
<Interface>
Defines one or more the user interfaces for the extension.
Type
Ansys_ACT_Core_XmlDataModel_Interface (p. 278)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Licenses>
Defines a licenses collection for the extension.
Type
Ansys_ACT_Core_XmlDataModel_Licenses (p. 318)
Remarks
None.
ACT XML Tags
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<script>
Specifies one or more IronPython scripts referenced by the extension.
Type
Ansys_ACT_Core_XmlDataModel_Script (p. 859)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
<Extension>
RealParent
None.
Mandatory
False
TypeId
<simdata>
Defines one or more general sections that store all user object definitions.
Type
Ansys_ACT_Core_XmlDataModel_SimData (p. 862)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Templates>
Defines a collection of control templates for the extension.
Type
Ansys_ACT_Core_XmlDataModel_Templates (p. 1027)
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<UIDefinition>
Defines one or more user interfaces for the extension.
Type
Ansys_ACT_Core_XmlDataModel_UI_UIDefinition (p. 1032)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
<Extension>
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Wizard>
Defines one or more wizards within the extension.
Type
Ansys_ACT_Core_XmlDataModel_Wizard (p. 1077)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Workflow>
Defines one or more user-defined custom workflows composed of tasks and task groups.
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Workflow (p. 1090)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
debug=
To start this extension in debug mode if in scripted mode.
Type
System_Boolean
Remarks
None.
Examples
None.
<Extension>
Details
Mandatory
False
Name
debug
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Icon for the extension.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
ACT XML Tags
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
isNative=
Specifies if the extension is native, in that case migration messages are ignored.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
isNative
DefaultValue
False
<Extension>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
loadAsDefault=
Specifies if the extension should be loaded automatically.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
loadAsDefault
DefaultValue
False
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
masked=
Specifies if the extension should be loaded automatically, but hidden in the Extension Manager.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
masked
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<Extension>
Public
False
Description
None.
TypeId
minorversion=
Minor version of the extension.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
minorversion
DefaultValue
0
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
ACT XML Tags
TypeId
name=
Name of the extension.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Extension>
ReadPythonFiles=
Primarly used by the AppBuilder to not read the python file but used file that are already read and
modified. ! Not Public !
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
ReadPythonFiles
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
version=
Major version of the extension.
ACT XML Tags
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
version
DefaultValue
1
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<ExtensionObject>
Class extending the extension object definition. (Inherited from DesignXplorer SimEntity)
Remarks
None.
<ExtensionObject>
Examples
None.

Callback <HostObjectModified> (p. 188) Callback that is invoked to return when the
properties of host object have changed.
ACT XML Tags
Tag <Target> (p. 205) Defines the target location for the object.
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<ExtensionObject>
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
<ExtensionObject>
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<HostObjectModified>
Callback that is invoked to return when the properties of host object have changed.
Type
Remarks
None.
Examples
None.
<ExtensionObject>
Details
CallbackType
Name
HostObjectModified
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnAdd>
Type
Remarks
Examples
None.
<ExtensionObject>
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
<ExtensionObject>
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
<ExtensionObject>
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
<ExtensionObject>
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnInit>
Type
Remarks
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
<ExtensionObject>
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
<ExtensionObject>
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
<ExtensionObject>
Details
CallbackType
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Property>
Type
Remarks
None.
Examples
None.
<ExtensionObject>
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Target>
Defines the target location for the object.
Type
Ansys_ACT_Core_XmlDataModel_Target (p. 943)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
ACT XML Tags
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
caption
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<ExtensionObject>
class=
Type
System_String
Remarks
Examples
None.
Details
DefaultValue
None.
Name
class
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
DefaultValue
True
Name
contextual
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
<ExtensionObject>
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
icon
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
ACT XML Tags
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
name
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Type
System_Int32
Remarks
None.
<FileToolbarView>
Examples
None.
Details
DefaultValue
None.
Name
version
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<FileToolbarView>
Remarks
None.
Examples
None.
Attribute buttonsComponent= (p. 212) No details provided.
ACT XML Tags

View)
buttonsComponent=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
buttonsComponent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<filter>
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<filter>
Class defining a filter for the object. The filtering mechanism itself is application specific.
ACT XML Tags
Remarks
None.
Examples
Example 1: The following example adds a filter to the <interface/> tag in order to specify the name of
an xml file that controls the visibility of Mechanical buttons. The details of the xml file content and as-
sociated mechanism are Mechanical specific.
<interface context="Mechanical">
<filter name="MainFilter" src="ButtonsVisibility.xml"/>
</interface>
Attribute name= (p. 214) Name of the filter.

Attribute src= (p. 215) Specifies the path of the reference script or
resource file.
name=
Name of the filter.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
<filter>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
src=
Specifies the path of the reference script or resource file.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
src
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
<Geometry>
Class defining a geometry feature.
Remarks
None.
Examples
None.

Callback <OnAfterGenerate> (p. 224) Callback that is invoked at the end of the
generation process.
<Geometry>
Callback <OnEdit> (p. 229) Callback that is invoked when the object is edited.
Callback <OnGenerate> (p. 230) Callback that is invoked when the object is
generated.
<Attributes>
Type
Remarks
None.
ACT XML Tags
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
<Geometry>
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
ACT XML Tags
Mandatory
False
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
<Geometry>
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Geometry>
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnAfterGenerate>
Callback that is invoked at the end of the generation process.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnAfterGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Geometry>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Geometry>
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Geometry>
<OnEdit>
Callback that is invoked when the object is edited.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnEdit
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnGenerate>
Callback that is invoked when the object is generated.
Type
Ansys_ACT_Core_XmlDataModel_CallbackOnGenerate (p. 62)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnGenerate
Name
OnGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Geometry>
<OnGenerateData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnHide>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Geometry>
<OnInit>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnMigrate>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Geometry>
<OnReady>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Geometry>
<OnShow>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnSuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Geometry>
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<Property>
Type
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
<Geometry>
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
ACT XML Tags
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
<Geometry>
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<Geometry>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
<guid>
Class defining a unique identifier for the extension.
Remarks
The GUID is he unique identifier of the extension. Two extensions with the same GUID will be considered
by ACT as the same extension.
This is very important when the extension is deployed to ensure that two different extensions will
never be in conflict (have the same name, for example).
This identifier must be added at least before the first build of the extension and must never changed
after that. When the extension is updated, a new version created, or features added... the GUID must
be kept unchanged.
Examples
Example 1: A GUID can be generated from the project's page command window using the following
code:
import System
System.Guid.NewGuid().ToString()
Attribute shortid= (p. 246) Short identifier for backward

compatibility.
shortid=
Short identifier for backward compatibility.
Type
System_String
Remarks
Must be the same as the extension name for all extensions created before R15.
<Image>
Examples
None.
Details
Name
shortid
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Image>
Remarks
None.
Examples
None.
Tag <Callbacks> (p. 248) Specifies the callbacks that will invoke functions from the
IronPython extension script. (inherited from Presentation)
ACT XML Tags
Callback <OnAdd> (p. 249) No details provided. (inherited from Presentation)

Callback <OnDelete> (p. 250) No details provided. (inherited from Presentation)
Callback <OnHighlight> (p. 251) No details provided. (inherited from Presentation)
Callback <OnUnhighlight> (p. 252) No details provided. (inherited from Presentation)
Callback <OnUpdate> (p. 253) No details provided. (inherited from Presentation)
Attribute allowHighlight= (p. 254) No details provided. (inherited from Presentation)
Attribute FileNameProperty= (p. 254) No details provided.
Attribute userObject= (p. 255) No details provided. (inherited from Presentation)
Attribute visibility= (p. 256) No details provided. (inherited from Presentation)
<Callbacks>
Presentation)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Image>
<OnAdd>
No details provided. (inherited from Presentation)
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IPresentation_
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnDelete>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDelete
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Image>
<OnHighlight>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHighlight
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnUnhighlight>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUnhighlight
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Image>
<OnUpdate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUpdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
allowHighlight=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
allowHighlight
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
FileNameProperty=
<Image>
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
FileNameProperty
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
userObject=
Type
System_String
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
userObject
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
visibility=
Type
Ansys_ACT_Interfaces_Presentations_VisibilityOptions
Remarks
None.
<includegroup>
Examples
None.
Details
Mandatory
False
Name
visibility
DefaultValue
Always
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<ImageDirectory>
Remarks
None.
Examples
None.
<includegroup>
Class defining the include group tag (used by task groups).
ACT XML Tags
Remarks
None.
Examples
None.
Attribute caption= (p. 258) The caption of the item to include. (inherited from IncludeTag)
Attribute external= (p. 259) Indicates whether the included item is defined outside of the extension
file. (inherited from IncludeTag)
Attribute name= (p. 260) Name of the item to include. (inherited from IncludeTag)
caption=
The caption of the item to include. (inherited from IncludeTag)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
<includegroup>
MappedValues
None.
Public
True
Description
None.
TypeId
external=
Indicates whether the included item is defined outside of the extension file. (inherited from IncludeTag)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
external
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
ACT XML Tags
Description
None.
TypeId
name=
Name of the item to include. (inherited from IncludeTag)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<includetask>
<includetask>
Class defining the include task tag (used by task groups).
Remarks
None.
Examples
None.
Attribute caption= (p. 261) The caption of the item to include. (inherited from IncludeTag)
Attribute external= (p. 262) Indicates whether the included item is defined outside of the extension
file. (inherited from IncludeTag)
Attribute name= (p. 263) Name of the item to include. (inherited from IncludeTag)
caption=
The caption of the item to include. (inherited from IncludeTag)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
external=
Indicates whether the included item is defined outside of the extension file. (inherited from IncludeTag)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
external
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
<includetask>
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the item to include. (inherited from IncludeTag)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
ACT XML Tags
Description
None.
TypeId
<input>
Class defining an input-level data connection definition.
Remarks
None.
Examples
None.
Attribute count= (p. 264) Maximum number of simultaneous input

instances.
Attribute format= (p. 265) Connection format type. (inherited from
IOItem)
Attribute type= (p. 266) Connection data type. (inherited from IOItem)
count=
Maximum number of simultaneous input instances.
Type
System_Int32
Remarks
None.
Examples
None.
Details
DefaultValue
-1
Name
count
<input>
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
format=
Connection format type. (inherited from IOItem)
Type
System_String
Remarks
This is used by upstream tasks or your task to determine what "specialized" format should be produced
for the more general "Type" property.
Examples
None.
Details
DefaultValue
None.
Name
format
Mandatory
False
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
type=
Connection data type. (inherited from IOItem)
Type
System_String
Remarks
Used to specify the input and output exposed object types for a task.
Examples
None.
Details
DefaultValue
None.
Name
type
Mandatory
False
DataDefinition
False
AllowedValues
None.
<inputfile>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<inputfile>
This class difines the InputFile XML Tag.
Remarks
None.
Examples
None.
Attribute id= (p. 267) The unique file id. (inherited

from File)
Attribute name= (p. 268) The file name. (inherited from
File)
id=
The unique file id. (inherited from File)
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
Details
DefaultValue
None.
Name
id
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
The file name. (inherited from File)
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
<inputFromActionOutput>
Name
name
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Remarks
None.
Examples
None.
Attribute action= (p. 269) No details provided.

Attribute Name= (p. 270) No details provided. (inherited from
Input)
Attribute output= (p. 271) No details provided.
action=
ACT XML Tags
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Name of action.
Name
action
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Name=
No details provided. (inherited from Input)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Name of the input.
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
output=
Type
System_String
Remarks
None.
ACT XML Tags
Examples
None.
Details
Mandatory
True
Description
Name of the output.
Name
output
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
<inputFromOperator>
Remarks
None.
Examples
None.

Input)
<inputFromOperator>
Attribute operator= (p. 274) No details provided.
Name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Name of the input.
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
ACT XML Tags
operator=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Name of the operator.
Name
operator
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
<inputgroup>
Class defining the input group collections for a task.
<inputgroup>
Remarks
None.
Examples
None.
Tag <Input> (p. 275) No details

provided.
<Input>
Type
Ansys_ACT_Core_XmlDataModel_Input (p. 264)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Input
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
ACT XML Tags
<inputs>
Class defining the inputs collection for a task.
Remarks
None.
Examples
None.
Tag <InputGroup> (p. 276) No details

provided.
<InputGroup>
Type
Ansys_ACT_Core_XmlDataModel_InputGroup (p. 274)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_InputGroup
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
<inputValue>
TypeId
<inputValue>
Remarks
None.
Examples
None.

Input)
Name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Name of the input.
Name
Name
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
<Interface>
Class defining the user interface for the extension.
Remarks
This interface element information pertains specifically to the GUI.
Examples
None.
Tag <Callbacks> (p. 279) No details provided.

Tag <filter> (p. 280) Defines one or more filters.
Callback <GetPostCommands> (p. 281) Called to collect all "post" commands to add to
the solver input file.
Callback <GetPreCommands> (p. 282) Called to collect all "pre" commands to add to the
solver input file.
Callback <GetSolveCommands> (p. 283) Called to collect all "solve" commands to add to
Callback <GetToolTips> (p. 284) Collect the GUI Entries ToolTips.
Tag <images> (p. 285) Defines the default folder where images to be
used by the extension are stored.
Callback <IsAnalysisValid> (p. 285) Called to know if an analysis is valid.
Callback <OnActiveObjectChange> (p. 286) Called when the active object change.
Callback <OnAfterGeometryUpdate> (p. 287) OnAfterGeometryUpdate.
Callback <OnAfterRemove> (p. 288) OnAfterRemove.
Callback <OnAfterSolve> (p. 289) Called when an analysis has been solved.
<Interface>
Callback <OnBeforeGeometryUpdate> (p. 290) OnBeforeGeometryUpdate.

Callback <OnBeforeSolve> (p. 291) Called when an analysis starts to solve.
Callback <OnBodySuppressStateChange> (p. 292) Called when the body suppress state change.
Callback <OnDraw> (p. 293) Called when the application is drawn.
Callback <OnDraw2D> (p. 294) Called when the application is drawn.
Callback <OnInit> (p. 295) Called when the given context is initialized.
Callback <OnLoad> (p. 296) Called when a project is loaded - invoked from
non-Workbench products
Callback <OnMeshCleaned> (p. 297) Called when the mesh is cleaned.
Callback <OnMeshGenerated> (p. 298) Called when the mesh is generated.
Callback <OnPostFinished> (p. 299) Called when the post process end for a given
analysis.
Callback <OnPostStarted> (p. 300) Called when the post process start for a given
analysis.
Callback <OnReady> (p. 301) OnReady.
Callback <OnSave> (p. 302) Called when a project is saved - invoked from
non-Workbench products
Callback <OnTerminate> (p. 303) Called when the given context is terminated.
Callback <OnUnitsChanged> (p. 304) OnUnitsChanged. Called when the unit system
changes.
Callback <Resume> (p. 305) Called when a project is loaded. Usefull to retreive
aditional data.
Callback <Save> (p. 306) Called when a project is saved. Usefull to save
aditional data.
Tag <toolbar> (p. 307) Defines one or more toolbars.
using '|') for the interface.
<Callbacks>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<filter>
Defines one or more filters.
Type
Ansys_ACT_Core_XmlDataModel_Filter (p. 213)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
<Interface>
TypeId
<GetPostCommands>
Called to collect all "post" commands to add to the solver input file.
Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 56)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetAnalysisSolveCommands
Name
GetPostCommands
Public
True
Obsolete
True
ObsoleteMessage
Use 'getcommands' callback with location="post".
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<GetPreCommands>
Called to collect all "pre" commands to add to the solver input file.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
GetPreCommands
Public
True
Obsolete
True
ObsoleteMessage
Use 'getcommands' callback with location="pre".
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Interface>
<GetSolveCommands>
Called to collect all "solve" commands to add to the solver input file.
Type
Remarks
If timeDependent is true, the callback take as argument : analysis, step, stream
Examples
None.
Details
CallbackType
Name
GetSolveCommands
Public
True
Obsolete
True
ObsoleteMessage
Use 'getcommands' callback with location="solve".
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<GetToolTips>
Collect the GUI Entries ToolTips.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetToolTips
Name
GetToolTips
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Interface>
<images>
Defines the default folder where images to be used by the extension are stored.
Type
System_String
Remarks
By default, all folders referenced by this tag are relatives to the folder of the extension.
Examples
None.
Details
Description
Add a folder to find images.
Name
images
ValueName
None.
Public
True
TypeId
<IsAnalysisValid>
Called to know if an analysis is valid.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsAnalysisValid
Name
IsAnalysisValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnActiveObjectChange>
Called when the active object change.
Type
Ansys_ACT_Core_XmlDataModel_CallbackOnActiveObjectChange (p. 59)
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActiveObjectChanged
Name
OnActiveObjectChange
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
OnAfterGeometryUpdate.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnAfterRemove>
OnAfterRemove.
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Name
OnAfterRemove
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnAfterSolve>
Called when an analysis has been solved.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBeforeSolveAnalysis
Name
OnAfterSolve
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnBeforeGeometryUpdate>
OnBeforeGeometryUpdate.
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Name
OnBeforeGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnBeforeSolve>
Called when an analysis starts to solve.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnBeforeSolve
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Called when the body suppress state change.
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnDraw>
Called when the application is drawn.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDraw
Name
OnDraw
Public
False
Obsolete
True
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnDraw2D>
Called when the application is drawn.
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDraw
Name
OnDraw2D
Public
False
Obsolete
True
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnInit>
Called when the given context is initialized.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInit
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnLoad>
Called when a project is loaded - invoked from non-Workbench products
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnLoadSave
Name
OnLoad
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnMeshCleaned>
Called when the mesh is cleaned.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnMeshCleaned
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnMeshGenerated>
Called when the mesh is generated.
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Name
OnMeshGenerated
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnPostFinished>
Called when the post process end for a given analysis.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnPostFinished
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnPostStarted>
Called when the post process start for a given analysis.
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Name
OnPostStarted
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnReady>
OnReady.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnSave>
Called when a project is saved - invoked from non-Workbench products
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnLoadSave
Name
OnSave
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnTerminate>
Called when the given context is terminated.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInit
Name
OnTerminate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnUnitsChanged>
OnUnitsChanged. Called when the unit system changes.
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Name
OnUnitsChanged
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Resume>
Called when a project is loaded. Usefull to retreive aditional data.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_ResumeExt
Name
Resume
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Save>
Called when a project is saved. Usefull to save aditional data.
Type
Remarks
None.
Examples
None.
<Interface>
Details
CallbackType
Ansys_ACT_Core_Callbacks_SaveExt
Name
Save
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<toolbar>
Defines one or more toolbars.
Type
Ansys_ACT_Core_XmlDataModel_Toolbar (p. 1028)
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
context=
Context or combination of contexts (separated using '|') for the interface.
Type
Remarks
This interface block will be taken into account only for specified context(s).
Examples
None.
Details
Mandatory
True
Name
context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<Layout>
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
<Layout>
Remarks
None.
Examples
None.
Tag <Component> (p. 309) Defines the component for which the panel layout is being defined.
(inherited from Layout)
Attribute name= (p. 310) Name of the layout. (inherited from Layout)
<Component>
Defines the component for which the panel layout is being defined. (inherited from Layout)
Type
Ansys_ACT_Core_XmlDataModel_UI_Component (p. 67)
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_UI_Component
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
name=
Name of the layout. (inherited from Layout)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<Layout>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Layout>
Class defining the a new panel layout.
Remarks
None.
Examples
None.
Tag <Component> (p. 311) Defines the component for which the panel layout is being
defined.
Attribute name= (p. 312) Name of the layout.
<Component>
Defines the component for which the panel layout is being defined.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
name=
Name of the layout.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<Layout>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Layout>
Remarks
None.
Examples
None.
<Component>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<Layout>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Layout>
Remarks
None.
Examples
None.
<Component>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<License>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<License>
Class defining a license to be used in the execution of an extension.
Remarks
None.
Examples
None.
Attribute name= (p. 317) Name of the

license.
name=
Name of the license.
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
Details
DefaultValue
None.
Name
name
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Licenses>
Class defining a licenses collection for the extension.
Remarks
None.
Examples
None.
Tag <License> (p. 318) A license collection defined for the

extension.
<License>
A license collection defined for the extension.
<Link>
Type
Ansys_ACT_Core_XmlDataModel_License (p. 317)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Link>
Class defining a new application task link.
Remarks
None.
Examples
None.
Attribute from= (p. 320) The name of the task where the link come
from.
Attribute to= (p. 320) The name of the task where the link go
to.
ACT XML Tags
from=
The name of the task where the link come from.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
from
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
to=
The name of the task where the link go to.
<Load>
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
to
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
<Load>
Class defining a simulation load or boundary.
Remarks
The <load> element and its children allow you to configure the properties of a custom load and specify
the IronPython functions that are invoked based on system and user-generated events.
ACT XML Tags
Examples
Example 1: The following example defines a load applicable to edges.
<load name="DemoLoad" version="1" caption="DemoLoad" icon="tload" color="#00FFFF">

<callbacks>
<getnodalvaluesfordisplay>NodeValues</getnodalvaluesfordisplay>
</callbacks>
<property name="Geometry" caption="Geometry" control="scoping">
<attributes selection_filter="edge" />
</property>
</load>
Callback <Action> (p. 323) No details provided.

Callback <GetCommands> (p. 329) Callback that is invoked to collect all commands
to add to the solver input file.
Callback <GetNodalValuesForDisplay> (p. 330) Callback that is invoked to get nodal values
associated with the load.
Callback <GetPostCommands> (p. 331) Callback that is invoked to collect all "post"
commands to add to the solver input file.
Callback <GetPreCommands> (p. 332) Callback that is invoked to collect all "pre"
Callback <GetSolveCommands> (p. 333) Callback that is invoked to collect all "solve"
Callback <OnAfterGenerate> (p. 336) Callback that is invoked after the generation is
completed.
Callback <OnDrawBodyViews> (p. 340) Called to collect all commands to add to the solver
input file.
<Load>
Callback <OnGenerate> (p. 342) Callback that is invoked when the load object is
generated.
Attribute AffectsSolution= (p. 352) Indicates whether the load object should affect
the solution or not.
Attribute color= (p. 355) Color of the scoped entities.
Attribute IsLoad= (p. 358) Indicates whether the load object should be
considered as a load boundary.
Attribute IsSupport= (p. 359) Indicates whether the load object should be
considered as a support boundary.
Attribute unit= (p. 361) Default unit used by the contour display.
<Action>
ACT XML Tags
Type
List_Action_
Remarks
None.
Examples
None.
Details
CallbackType
None.
Name
Action
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Attributes>
<Load>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
<Load>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
ACT XML Tags
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
<Load>
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<GetCommands>
Callback that is invoked to collect all commands to add to the solver input file.
Type
List_CallbackGetCommands_
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetCommands
Name
GetCommands
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
ACT XML Tags
RealParent
Mandatory
False
TypeId
<GetNodalValuesForDisplay>
Callback that is invoked to get nodal values associated with the load.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetNodeValues
Name
GetNodalValuesForDisplay
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
<Load>
Mandatory
False
TypeId
<GetPostCommands>
Callback that is invoked to collect all "post" commands to add to the solver input file.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands
Name
GetPostCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
ACT XML Tags
TypeId
<GetPreCommands>
Callback that is invoked to collect all "pre" commands to add to the solver input file.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
GetPreCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Load>
<GetSolveCommands>
Callback that is invoked to collect all "solve" commands to add to the solver input file.
Type
Remarks
Examples
None.
Details
CallbackType
Name
GetSolveCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Load>
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnAfterGenerate>
Callback that is invoked after the generation is completed.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnAfterGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Load>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Load>
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnDrawBodyViews>
Called to collect all commands to add to the solver input file.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDrawBodyViews
Name
OnDrawBodyViews
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Load>
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnGenerate>
Callback that is invoked when the load object is generated.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Load>
<OnGenerateData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnHide>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Load>
<OnInit>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnMigrate>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Load>
<OnReady>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Load>
<OnShow>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnSuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Load>
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<Property>
Type
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
AffectsSolution=
Indicates whether the load object should affect the solution or not.
Type
System_Boolean
Remarks
None.
Examples
None.
<Load>
Details
Mandatory
False
Name
AffectsSolution
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
ACT XML Tags
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
<Load>
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
color=
Color of the scoped entities.
Type
System_String
Remarks
The format of the color is the same as for an HTML page. It's #rrggbb where rr is a 2-digit integer in
hexadecimal for the red part, gg is a 2-digit integer in hexadecimal for the green part, and bb is a 2-
digit integer in hexadecimal for the blue part.
Examples
Example 1: For example:
White: #FFFFFF
Black: #000000
Red: #FF0000
Green: #00FF00
Blue: #0000FF
ACT XML Tags
Details
Mandatory
False
Name
color
DefaultValue
#00ff00
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
<Load>
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
IsLoad=
Indicates whether the load object should be considered as a load boundary.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
IsLoad
DefaultValue
False
DataDefinition
False
AllowedValues
None.
<Load>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
IsSupport=
Indicates whether the load object should be considered as a support boundary.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
IsSupport
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
<Load>
TypeId
unit=
Default unit used by the contour display.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
unit
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
version=
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<nativepropertytable>
Class encapsulating a list of child properties under one table.
Remarks
None.
Examples
None.
Tag <Attributes> (p. 365) No details provided. (inherited from PropertyBase)

Tag <Callbacks> (p. 365) No details provided. (inherited from PropertyBase)
Callback <GetValue> (p. 366) Callback that is invoked when the property value
is acquired. (inherited from PropertyBase)
Tag <help> (p. 367) No details provided. (inherited from PropertyBase)
Callback <IsValid> (p. 368) Callback that is invoked to determine whether the
property is valid. (inherited from PropertyBase)
Callback <IsVisible> (p. 369) Callback that is invoked to determine whether the
property is visible. (inherited from PropertyBase)
Callback <OnActivate> (p. 370) Callback that is invoked when the property is
activated. (inherited from PropertyBase)
Callback <OnAdd> (p. 371) Callback that is invoked when the property is
added. (inherited from PropertyBase)
Callback <OnAfterGeometryUpdate> (p. 372) Callback that is invoked after the geometry has
been updated. (inherited from PropertyBase)
Callback <OnApply> (p. 373) Callback that is invoked when the property apply
button is clicked. (inherited from PropertyBase)
state change. (inherited from PropertyBase)
Callback <OnButtonClick> (p. 375) Callback that is invoked when click on a property's
button (inherited from PropertyBase)
Callback <OnCancel> (p. 376) Callback that is invoked when the property cancel
Callback <OnDuplicate> (p. 377) Callback that is invoked when the property is
duplicated. (inherited from PropertyBase)
Callback <OnHide> (p. 378) Callback that is invoked when the property is
hidden. (inherited from PropertyBase)
Callback <OnInit> (p. 379) Callback that is invoked when the property is
initialized. (inherited from PropertyBase)
Callback <OnJournalExecuting> (p. 380) Callback that is invoked before executing an action
written in the journal. (inherited from
PropertyBase)
Callback <OnJournalRecording> (p. 381) Callback that is invoked before writting the journal
for an action. (inherited from PropertyBase)
Callback <OnMigrate> (p. 382) Callback that is invoked when the property version
has been changed. (inherited from PropertyBase)
ACT XML Tags
Callback <OnRemove> (p. 383) Callback that is invoked when the property is
removed. (inherited from PropertyBase)
Callback <OnShow> (p. 384) Callback that is invoked when the property is
shown. (inherited from PropertyBase)
Callback <OnValidate> (p. 385) Callback that is invoked when the property is
validated. (inherited from PropertyBase)
Callback <SetValue> (p. 386) Callback that is invoked when the property value
is set. (inherited from PropertyBase)
Callback <String2Value> (p. 387) Callback that is invoked to convert a string to the
property value. (inherited from PropertyBase)
Callback <Value2String> (p. 388) Callback that is invoked to convert the value
stored by the property into a string. (inherited
from PropertyBase)
Attribute allowempty= (p. 389) Unit type of the property (for float control).
Attribute caption= (p. 390) Caption of the property. (inherited from
PropertyBase)
Attribute class= (p. 391) Class name of the property's controller. (inherited
from PropertyBase)
Attribute control= (p. 392) Control type of the object.
Attribute default= (p. 393) Default value of the property. (inherited from
PropertyBase)
Attribute display= (p. 394) Display type of the property group.
Attribute elementtype= (p. 395) Property list element type (workflow). (inherited
from PropertyBase)
Attribute isparameter= (p. 396) Indicates whether the property is a parameter.
(inherited from PropertyBase)
Attribute keytype= (p. 397) Property dictionary key type (workflow). (inherited
from PropertyBase)
Attribute name= (p. 397) Name of the property. (inherited from
PropertyBase)
Attribute needupdate= (p. 398) Indicates whether the context must be refreshed
when the property value changes. (inherited from
PropertyBase)
Attribute parameterizable= (p. 399) Specifies the property parameterization (workflow).
Indicates whether the property should be a
candidate for parameterization (in the schematic
property view, a check-box will appear). (inherited
from PropertyBase)
Attribute persistent= (p. 400) Specifies the property persistence (workflow).
Indicates whether the property data should be
saved within the project. (inherited from
PropertyBase)
Attribute readonly= (p. 401) Indicates whether the property is read-only.
Attribute unit= (p. 402) Unit type of the property (for 'control' equals to
'float' only). (inherited from PropertyBase)
Attribute valuetype= (p. 403) Property dictionary value type (workflow).
Attribute visible= (p. 404) Indicates whether the property is visible. (inherited
from PropertyBase)
Attribute visibleon= (p. 405) Specifies property visibility. With a PropertyGroup
parent of control type "select", indicates the select
values for this property to be visible (separate with
'|'). (inherited from PropertyBase)
<Attributes>
No details provided. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<GetValue>
Callback that is invoked when the property value is acquired. (inherited from PropertyBase)
Type
Remarks
This callback is useful for transforming the stored property value.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue
Name
GetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<help>
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
Details
Description
Indicate the help that will be shown for the property. (Wizard only)
Name
help
ValueName
None.
Public
True
TypeId
<IsValid>
Callback that is invoked to determine whether the property is valid. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValid
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<IsVisible>
Callback that is invoked to determine whether the property is visible. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsVisible
Name
IsVisible
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
ACT XML Tags
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnActivate>
Callback that is invoked when the property is activated. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnActivate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnAdd>
Callback that is invoked when the property is added. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
ACT XML Tags
Mandatory
False
TypeId
Callback that is invoked after the geometry has been updated. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnApply>
Callback that is invoked when the property apply button is clicked. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnApply
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
Callback that is invoked when the body suppress state change. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnButtonClick>
Callback that is invoked when click on a property's button (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnButtonClick
Name
OnButtonClick
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnCancel>
Callback that is invoked when the property cancel button is clicked. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnCancel
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnDuplicate>
Callback that is invoked when the property is duplicated. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnHide>
Callback that is invoked when the property is hidden. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnInit>
Callback that is invoked when the property is initialized. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnJournalExecuting>
Callback that is invoked before executing an action written in the journal. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnJournalExecuting
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnJournalRecording>
Callback that is invoked before writting the journal for an action. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnJournalRecording
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnMigrate>
Callback that is invoked when the property version has been changed. (inherited from PropertyBase)
Type
Remarks
This callback allows the migration of data from the old saved property to the new one.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnPropertyMigrate
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnRemove>
Callback that is invoked when the property is removed. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnShow>
Callback that is invoked when the property is shown. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnValidate>
Callback that is invoked when the property is validated. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnValidate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<Property>
Type
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<SetValue>
Callback that is invoked when the property value is set. (inherited from PropertyBase)
Type
Remarks
This callback is useful for transforming the submitted property value.
Examples
None.
Details
CallbackType
Name
SetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<String2Value>
Callback that is invoked to convert a string to the property value. (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_String2Value
Name
String2Value
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Value2String>
Callback that is invoked to convert the value stored by the property into a string. (inherited from
PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_Value2String
Name
Value2String
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
allowempty=
Unit type of the property (for float control).
Type
System_Boolean
Remarks
None.
Examples
None.
ACT XML Tags
Details
Name
allowempty
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
caption=
Caption of the property. (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
caption
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Class name of the property's controller. (inherited from PropertyBase)
Type
System_String
Remarks
The constructor of the class referenced by this attribute takes three arguments:
• The load associated to the property (of type IUserObject)
• The associated property (of type ISimProperty)
Examples
None.
Details
Name
class
ACT XML Tags
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
control=
Control type of the object.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
control
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
default=
Default value of the property. (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
default
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
display=
Display type of the property group.
Type
Ansys_ACT_Interfaces_UserObject_PropertyDisplayEnum
Remarks
None.
Examples
None.
Details
Name
display
Mandatory
False
DefaultValue
Caption
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
elementtype=
Property list element type (workflow). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
elementtype
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
ACT XML Tags
TypeId
isparameter=
Indicates whether the property is a parameter. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
isparameter
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
keytype=
Property dictionary key type (workflow). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
keytype
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the property. (inherited from PropertyBase)
ACT XML Tags
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
needupdate=
Indicates whether the context must be refreshed when the property value changes. (inherited from
PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
needupdate
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
parameterizable=
Specifies the property parameterization (workflow). Indicates whether the property should be a can-
didate for parameterization (in the schematic property view, a check-box will appear). (inherited from
PropertyBase)
Type
System_Boolean
Remarks
None.
ACT XML Tags
Examples
None.
Details
Name
parameterizable
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
persistent=
Specifies the property persistence (workflow). Indicates whether the property data should be saved
within the project. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
persistent
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
readonly=
Indicates whether the property is read-only. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
readonly
ACT XML Tags
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
unit=
Unit type of the property (for 'control' equals to 'float' only). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
unit
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
valuetype=
Property dictionary value type (workflow). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
valuetype
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
visible=
Indicates whether the property is visible. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
visible
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
visibleon=
Specifies property visibility. With a PropertyGroup parent of control type "select", indicates the select
values for this property to be visible (separate with '|'). (inherited from PropertyBase)
Type
Remarks
None.
Examples
None.
Details
Name
visibleon
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
ACT XML Tags
Description
None.
TypeId
<Object>
Class defining an object.
Remarks
None.
Examples
None.

Callback <GetCommands> (p. 413) Called to collect all commands to add to the solver
input file.
Callback <GetNodalValuesForDisplay> (p. 414) Called to get nodal values associated to the load.
Callback <GetPostCommands> (p. 415) Called to collect all "post" commands to add to
Callback <GetPreCommands> (p. 416) Called to collect all "pre" commands to add to the
solver input file.
Callback <GetSolveCommands> (p. 417) Called to collect all "solve" commands to add to
Callback <OnAfterGenerate> (p. 420) Called when the generation is completed.
<Object>
Callback <OnDrawBodyViews> (p. 424) Called to collect all commands to add to the solver
input file.
Callback <OnGenerate> (p. 426) Called when the load object is generated.
Tag <Target> (p. 436) Defines the target location for the object.
Attribute AffectsSolution= (p. 437) Indicates whether the load object should affect
the solution or not.
Attribute color= (p. 440) Color of scoped entities.
Attribute IsLoad= (p. 443) Indicates whether the load object should be
considered as a load boundary.
Attribute IsSupport= (p. 444) Indicates whether the load object should be
considered as a support boundary.
Attribute unit= (p. 445) Default unit used by the contour display.
ACT XML Tags
<Action>
Type
List_Action_
Remarks
None.
Examples
None.
Details
CallbackType
None.
Name
Action
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Object>
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
<Object>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
ACT XML Tags
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
<Object>
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<GetCommands>
Type
List_CallbackGetCommands_
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetCommands
Name
GetCommands
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
ACT XML Tags
RealParent
Mandatory
False
TypeId
<GetNodalValuesForDisplay>
Called to get nodal values associated to the load.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetNodeValues
Name
GetNodalValuesForDisplay
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
<Object>
Mandatory
False
TypeId
<GetPostCommands>
Called to collect all "post" commands to add to the solver input file.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
GetPostCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
ACT XML Tags
TypeId
<GetPreCommands>
Called to collect all "pre" commands to add to the solver input file.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
GetPreCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Object>
<GetSolveCommands>
Called to collect all "solve" commands to add to the solver input file.
Type
Remarks
Examples
None.
Details
CallbackType
Name
GetSolveCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Object>
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnAfterGenerate>
Called when the generation is completed.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnAfterGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Object>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Object>
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnDrawBodyViews>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDrawBodyViews
Name
OnDrawBodyViews
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Object>
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnGenerate>
Called when the load object is generated.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Object>
<OnGenerateData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnHide>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Object>
<OnInit>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnMigrate>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Object>
<OnReady>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Object>
<OnShow>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnSuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Object>
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<Property>
Type
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Target>
Defines the target location for the object.
Type
Ansys_ACT_Core_XmlDataModel_Target (p. 943)
Remarks
None.
Examples
None.
<Object>
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
AffectsSolution=
Indicates whether the load object should affect the solution or not.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
True
Name
AffectsSolution
Mandatory
False
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
caption
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<Object>
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
DefaultValue
None.
Name
class
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
color=
Color of scoped entities.
Type
System_String
Remarks
The format of the color is the same as for an HTML page. It's #rrggbb where rr is a 2-digit integer in
hexadecimal for the red part, gg is a 2-digit integer in hexadecimal for the green part, and bb is a 2-
digit integer in hexadecimal for the blue part.
Examples
Example 1: For example:
White: #FFFFFF
Black: #000000
Red: #FF0000
Green: #00FF00
Blue: #0000FF
Details
DefaultValue
#00ff00
Name
color
Mandatory
False
DataDefinition
False
AllowedValues
None.
<Object>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
DefaultValue
True
Name
contextual
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
icon
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
<Object>
TypeId
IsLoad=
Indicates whether the load object should be considered as a load boundary.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Name
IsLoad
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
ACT XML Tags
IsSupport=
Indicates whether the load object should be considered as a support boundary.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Name
IsSupport
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
name=
<Object>
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
name
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
unit=
Default unit used by the contour display.
Type
System_String
ACT XML Tags
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
unit
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Type
System_Int32
Remarks
None.
<operator>
Examples
None.
Details
DefaultValue
None.
Name
version
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<operator>
Remarks
None.
Examples
None.
Tag <InputValue> (p. 448) No details

provided.
ACT XML Tags

provided.
Attribute Type= (p. 449) No details
provided.
<InputValue>
Type
Ansys_ACT_Core_XmlDataModel_Language_InputValue (p. 277)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Language_InputValue
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Name=
Type
System_String
<operator>
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Name of the variable associated to this operator.
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Type=
Type
System_String
Remarks
None.
ACT XML Tags
Examples
None.
Details
Mandatory
True
Description
Type of the operator.
Name
Type
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
<Optimizer>
Class defining an optimizer.
Remarks
None.
Examples
None.
Tag <Attributes> (p. 454) No details provided. (inherited from

SimEntity)
<Optimizer>
Tag <Callbacks> (p. 455) No details provided. (inherited from

SimEntity)
Callback <CanAdd> (p. 456) Callback that is invoked to determine
whether the object can be added.
Callback <CanDuplicate> (p. 457) Callback that is invoked to determine if
the object can be duplicated. (inherited
from SimEntity)
Callback <CanRemove> (p. 458) Callback that is invoked to determine if
the object can be removed. (inherited
from SimEntity)
Callback <CanRun> (p. 459) Callback that is invoked to indicate
whether the optimizer (or sampling) is
able to process the optimization (design
of experiments) study with its current
configuration. (inherited from
DesignExplorer)
Callback <Configuration> (p. 460) Callback that is invoked to return a
userreadable string summarizing the
current configuration of the optimizer
(or the sampling). (inherited from
DesignExplorer)
Callback <ConvergenceDescription> (p. 461) Callback that is invoked to return a
DXConvergenceDescription object
describing the convergence data
provided.
Callback <Description> (p. 462) Callback that is invoked to return a
user-readable string describing the
optimizer and its specific capabilities.
(inherited from DesignExplorer)
Callback <InputParametersEdited> (p. 463) Callback that is invoked when the
properties of input parameters have
changed. (inherited from
DesignExplorer)
Callback <IsValid> (p. 464) Callback that is invoked to determine if
the object is valid. (inherited from
SimEntity)
Callback <MethodPropertiesEdited> (p. 465) Callback that is invoked when the
properties of the optimization method
have changed. (inherited from
DesignExplorer)
Callback <ObjectivesOrConstraintsEdited> (p. 466) Callback that is invoked when the
definition of objectives or constraints
have changed.
Callback <OnAdd> (p. 467) Callback that is invoked when the object
is newly added. (inherited from
SimEntity)
ACT XML Tags
Callback <OnAfterGeometryUpdate> (p. 468) Callback that is invoked when the

geometry has been updated. (inherited
from SimEntity)
Callback <OnBodySuppressStateChange> (p. 469) Callback that is invoked when the body
suppress state changse. (inherited from
SimEntity)
Callback <OnClearData> (p. 470) Callback that is invoked when object
data are cleared. (inherited from
SimEntity)
Callback <OnCreate> (p. 471) Callback that is invoked to provide an
instance of IOptimizationMethod (or
ISamplingMethod). (inherited from
DesignExplorer)
Callback <OnDuplicate> (p. 472) Callback that is invoked when the object
is duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 473) Callback that is invoked when object
data are generated. (inherited from
SimEntity)
Callback <OnHide> (p. 474) Callback that is invoked when the object
is hidden. (inherited from SimEntity)
Callback <OnInit> (p. 475) Callback that is invoked when the object
is initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 476) Callback that is invoked when the object
version has been changed. (inherited
from SimEntity)
Callback <OnReady> (p. 477) Callback that is invoked when the
application is fully loaded and in a
"ready" state. (Inherited from SimEntity)
Callback <OnRelease> (p. 478) Callback that is invoked to release the
IOptimizationMethod (or the
ISamplingMethod) instance. (inherited
from DesignExplorer)
Callback <OnRemove> (p. 479) Callback that is invoked when the object
is removed. (inherited from SimEntity)
Callback <OnShow> (p. 480) Callback that is invoked when the object
is shown. (inherited from SimEntity)
Callback <OnSuppress> (p. 481) Callback that is invoked when the object
is suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 482) Callback that is invoked when the object
is unsuppressed. (inherited from
SimEntity)
Callback <ParameterRelationshipsEdited> (p. 483) Callback that is invoked when the
definition of parameter relationships
have changed.
Tag <Property> (p. 484) No details provided. (inherited from
SimEntity)
<Optimizer>
Callback <QuickHelp> (p. 484) Callback that is invoked to return a

user-readable string helping to
understand the state of the optimizer
(or the sampling) when CanRun is false.
Callback <Status> (p. 485) Callback that is invoked to return a
status of the optimization (or the
sampling) resolution. (inherited from
DesignExplorer)
Attribute basedondirectoptimizationonly= (p. 486) True if the optimizer is only available in
the context of a Direct Optimization
component; false otherwise.
Attribute basedonresponsesurfaceonly= (p. 487) True if the optimizer is only available in
the context of a Response Surface
component; false otherwise.
Attribute caption= (p. 488) Caption of the object. (inherited from
SimEntity)
Attribute class= (p. 489) Class name of the controller of the
object. (inherited from SimEntity)
Attribute constrainthandling= (p. 490) Supports constraint handling.
Attribute constraintimportance= (p. 491) Supports the Importance property of a
constraint.
Attribute constraintoninputparameter= (p. 492) Supports constraints defined on an
input parameter.
Attribute contextual= (p. 493) Indicates whether the object has to be
displayed in the contextual menu.
Attribute convergencedata= (p. 494) Provides convergence data.
Attribute equaltoconstraint= (p. 495) Supports the Equal To constraint type.
Attribute greaterthanconstraint= (p. 495) Supports the Greater Than constraint
type.
Attribute gridintervaloninputparameter= (p. 496) Supports grid interval defined on an
Input Parameter.
Attribute historychartxaxistype= (p. 497) Defines the X axis type for history charts.
Attribute icon= (p. 498) Icon for the object. (inherited from
SimEntity)
Attribute insideboundsconstraint= (p. 499) Supports the Inside Bounds constraint
type.
Attribute lessthanconstraint= (p. 500) Supports the Less Than constraint type.
Attribute logfile= (p. 501) Provides messages to generate a log file.
Attribute maximizeobjective= (p. 502) Supports the Maximize objective type.
Attribute maximumnumberofconstraints= (p. 503) Defines the maximum number of
constraints supported by the optimizer.
ACT XML Tags
Attribute maximumnumberofdoublelistparameters= (p. 504) Indicates the maximum number of

double list parameters supported.
Attribute maximumnumberofdoubleparameters= (p. 505) Indicates the maximum number of
double parameters supported. (inherited
Attribute maximumnumberofinputparameters= (p. 505) Indicates the maximum number of input
parameters supported. (inherited from
DesignExplorer)
Attribute maximumnumberofintegerlistparameters= (p. 506) Indicates the maximum number of
integer list parameters supported.
Attribute maximumnumberofobjectives= (p. 507) Defines the maximum number of
objectives supported by the optimizer.
Attribute minimizeobjective= (p. 508) Supports the Minimize objective type.
Attribute minimumnumberofconstraints= (p. 509) Defines the minimum number of
constraints required.
Attribute minimumnumberofobjectives= (p. 510) Defines the minimum number of
objectives required.
Attribute name= (p. 511) Name of the object. (inherited from
SimEntity)
Attribute objectiveimportance= (p. 512) Supports the Importance property of an
objective.
Attribute objectiveoninputparameter= (p. 513) Supports objectives defined on an Input
Parameter.
Attribute parameterrelationship= (p. 514) Supports parameter relationships.
Attribute seekobjective= (p. 515) Supports the Seek objective type.
Attribute startingpointrequired= (p. 515) Requires a Starting Point.
Attribute version= (p. 516) Version of the object. (inherited from
SimEntity)
<Attributes>
Type
Remarks
None.
Examples
None.
<Optimizer>
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
ACT XML Tags
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Optimizer>
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Optimizer>
<CanRun>
Callback that is invoked to indicate whether the optimizer (or sampling) is able to process the optim-
ization (design of experiments) study with its current configuration. (inherited from DesignExplorer)
Type
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__bool_
Name
CanRun
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<Configuration>
Callback that is invoked to return a userreadable string summarizing the current configuration of the
optimizer (or the sampling). (inherited from DesignExplorer)
Type
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__string_
Name
Configuration
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Optimizer>
<ConvergenceDescription>
Callback that is invoked to return a DXConvergenceDescription object describing the convergence
data provided.
Type
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__object_
Name
ConvergenceDescription
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<Description>
Callback that is invoked to return a user-readable string describing the optimizer and its specific
capabilities. (inherited from DesignExplorer)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Description
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Optimizer>
<InputParametersEdited>
Callback that is invoked when the properties of input parameters have changed. (inherited from De-
signExplorer)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
InputParametersEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Optimizer>
<MethodPropertiesEdited>
Callback that is invoked when the properties of the optimization method have changed. (inherited
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
MethodPropertiesEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<ObjectivesOrConstraintsEdited>
Callback that is invoked when the definition of objectives or constraints have changed.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
ObjectivesOrConstraintsEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Optimizer>
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Optimizer>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Optimizer>
<OnCreate>
Callback that is invoked to provide an instance of IOptimizationMethod (or ISamplingMethod). (inherited
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Optimizer>
<OnGenerateData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnHide>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Optimizer>
<OnInit>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnMigrate>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Optimizer>
<OnReady>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnRelease>
Callback that is invoked to release the IOptimizationMethod (or the ISamplingMethod) instance. (in-
herited from DesignExplorer)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRelease
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Optimizer>
<OnRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnShow>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Optimizer>
<OnSuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Optimizer>
<ParameterRelationshipsEdited>
Callback that is invoked when the definition of parameter relationships have changed.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
ParameterRelationshipsEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<Property>
Type
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<QuickHelp>
Callback that is invoked to return a user-readable string helping to understand the state of the optim-
izer (or the sampling) when CanRun is false. (inherited from DesignExplorer)
Type
Remarks
None.
<Optimizer>
Examples
None.
Details
CallbackType
Name
QuickHelp
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Status>
Callback that is invoked to return a user-readable string describing the status of the optimization (or
the sampling) resolution. (inherited from DesignExplorer)
Type
Remarks
None.
ACT XML Tags
Examples
None.
Details
CallbackType
Name
Status
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
basedondirectoptimizationonly=
True if the optimizer is only available in the context of a Direct Optimization component; false other-
wise.
Type
System_Boolean
Remarks
None.
<Optimizer>
Examples
None.
Details
Name
basedondirectoptimizationonly
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
basedonresponsesurfaceonly=
True if the optimizer is only available in the context of a Response Surface component; false otherwise.
Type
System_Boolean
Remarks
None.
Examples
None.
ACT XML Tags
Details
Name
basedonresponsesurfaceonly
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
<Optimizer>
Name
caption
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
DefaultValue
None.
ACT XML Tags
Name
class
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
constrainthandling=
Supports constraint handling.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
constrainthandling
Mandatory
False
DefaultValue
False
<Optimizer>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
constraintimportance=
Supports the Importance property of a constraint.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
constraintimportance
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
constraintoninputparameter=
Supports constraints defined on an input parameter.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
constraintoninputparameter
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<Optimizer>
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
DefaultValue
True
Name
contextual
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
ACT XML Tags
TypeId
convergencedata=
Provides convergence data.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
convergencedata
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Optimizer>
equaltoconstraint=
Supports the Equal To constraint type.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
equaltoconstraint
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
greaterthanconstraint=
Supports the Greater Than constraint type.
ACT XML Tags
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
greaterthanconstraint
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
gridintervaloninputparameter=
Supports grid interval defined on an Input Parameter.
Type
System_Boolean
<Optimizer>
Remarks
None.
Examples
None.
Details
Name
gridintervaloninputparameter
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
historychartxaxistype=
Defines the X axis type for history charts.
Type
System_String
Remarks
None.
ACT XML Tags
Examples
None.
Details
Name
historychartxaxistype
Mandatory
False
DefaultValue
bypoint
DataDefinition
False
AllowedValues
System.String[]
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
<Optimizer>
Details
DefaultValue
None.
Name
icon
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
insideboundsconstraint=
Supports the Inside Bounds constraint type.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
insideboundsconstraint
ACT XML Tags
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
lessthanconstraint=
Supports the Less Than constraint type.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
lessthanconstraint
Mandatory
False
DefaultValue
True
<Optimizer>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
logfile=
Provides messages to generate a log file. (inherited from DesignExplorer)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Name
logfile
Mandatory
False
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
maximizeobjective=
Supports the Maximize objective type.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
maximizeobjective
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<Optimizer>
Public
True
Description
None.
TypeId
maximumnumberofconstraints=
Defines the maximum number of constraints supported by the optimizer.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
maximumnumberofconstraints
Mandatory
False
DefaultValue
100
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
ACT XML Tags
TypeId
maximumnumberofdoublelistparameters=
Indicates the maximum number of double list parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Remarks
None.
Examples
None.
Details
DefaultValue
100
Name
maximumnumberofdoublelistparameters
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Optimizer>
maximumnumberofdoubleparameters=
Indicates the maximum number of double parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Remarks
None.
Examples
None.
Details
DefaultValue
100
Name
maximumnumberofdoubleparameters
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
maximumnumberofinputparameters=
Indicates the maximum number of input parameters supported. (inherited from DesignExplorer)
ACT XML Tags
Type
System_Int32
Remarks
None.
Examples
None.
Details
DefaultValue
100
Name
maximumnumberofinputparameters
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
maximumnumberofintegerlistparameters=
Indicates the maximum number of integer list parameters supported. (inherited from DesignExplorer)
Type
System_Int32
<Optimizer>
Remarks
None.
Examples
None.
Details
DefaultValue
100
Name
maximumnumberofintegerlistparameters
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
maximumnumberofobjectives=
Defines the maximum number of objectives supported by the optimizer.
Type
System_Int32
Remarks
None.
ACT XML Tags
Examples
None.
Details
Name
maximumnumberofobjectives
Mandatory
False
DefaultValue
100
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
minimizeobjective=
Supports the Minimize objective type.
Type
System_Boolean
Remarks
None.
Examples
None.
<Optimizer>
Details
Name
minimizeobjective
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
minimumnumberofconstraints=
Defines the minimum number of constraints required.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
minimumnumberofconstraints
ACT XML Tags
Mandatory
False
DefaultValue
0
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
minimumnumberofobjectives=
Defines the minimum number of objectives required.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
minimumnumberofobjectives
Mandatory
False
DefaultValue
1
<Optimizer>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
name
Mandatory
True
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
objectiveimportance=
Supports the Importance property of an objective.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
objectiveimportance
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<Optimizer>
Public
True
Description
None.
TypeId
objectiveoninputparameter=
Supports objectives defined on an Input Parameter.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
objectiveoninputparameter
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
ACT XML Tags
TypeId
parameterrelationship=
Supports parameter relationships.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
parameterrelationship
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Optimizer>
seekobjective=
Supports the Seek objective type.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
seekobjective
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
startingpointrequired=
Requires a Starting Point.
ACT XML Tags
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
startingpointrequired
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Type
System_Int32
<OrderableCallback>
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
version
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<OrderableCallback>
A callback that supports an order specification. Used when multiple callbacks could apply to the same
entity, allowing a proper "sorting" of execution.
Remarks
None.
ACT XML Tags
Examples
None.
Attribute order= (p. 519) The order "priority". The lower the order, the earlier the execution.
caninterrupt=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
caninterrupt
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
<OrderableCallback>
Description
None.
TypeId
order=
The order "priority". The lower the order, the earlier the execution.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
order
Mandatory
False
DefaultValue
0
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
<output>
Class defining an output-level data connection definition.
Remarks
None.
Examples
None.
Attribute format= (p. 520) Connection format type. (inherited from

IOItem)
Attribute type= (p. 521) Connection data type. (inherited from
IOItem)
format=
Connection format type. (inherited from IOItem)
Type
System_String
Remarks
This is used by upstream tasks or your task to determine what "specialized" format should be produced
for the more general "Type" property.
Examples
None.
Details
DefaultValue
None.
Name
format
Mandatory
False
DataDefinition
False
<output>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
type=
Connection data type. (inherited from IOItem)
Type
System_String
Remarks
Used to specify the input and output exposed object types for a task.
Examples
None.
Details
DefaultValue
None.
Name
type
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
<outputfile>
This class defines the OutputFile XML Tag.
Remarks
None.
Examples
None.
Attribute id= (p. 522) The unique file id. (inherited

from File)
Attribute name= (p. 523) The file name. (inherited from
File)
id=
The unique file id. (inherited from File)
Type
System_String
Remarks
None.
Examples
None.
<outputfile>
Details
DefaultValue
None.
Name
id
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
The file name. (inherited from File)
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
ACT XML Tags
Name
name
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<outputs>
Class defining the outputs collection for a task.
Remarks
None.
Examples
None.
Tag <Output> (p. 524) No details

provided.
<Output>
Type
Ansys_ACT_Core_XmlDataModel_Output (p. 520)
<Panel>
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Output
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Panel>
Remarks
None.
Examples
None.
Tag <Callbacks> (p. 526) Specifies the callbacks that will invoke functions
from the IronPython extension script. (Inherited from
SimEntity)
Tag <DialogProgressMonitorView> (p. 526) No details provided.
Callback <OnPanelHidden> (p. 527) Callback that is invoked when the panel is hidden.
Callback <OnPanelInitialized> (p. 528) Callback that is invoked when the panel is initialized.
Callback <OnPanelShown> (p. 529) Callback that is invoked when the panel is shown.
ACT XML Tags
Attribute layout= (p. 531) Layout of the panel.

Attribute name= (p. 532) Name of the panel.
<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script. (Inherited from
SimEntity)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Type
Ansys_ACT_Core_XmlDataModel_Application_DialogProgressMonitorView (p. 119)
<Panel>
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_DialogProgressMonitorView
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<OnPanelHidden>
Callback that is invoked when the panel is hidden.
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IPanelComponent_
Name
OnPanelHidden
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnPanelInitialized>
Callback that is invoked when the panel is initialized.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnPanelInitialized
Public
True
<Panel>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnPanelShown>
Callback that is invoked when the panel is shown.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnPanelShown
Public
True
Obsolete
False
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
class=
Class name of the controller of the object.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<Panel>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
layout=
Layout of the panel.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
layout
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
name=
Name of the panel.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
<PanelComponent>
TypeId
<PanelComponent>
Remarks
None.
Examples
None.
Tag <Attributes> (p. 534) Defines the set of attributes for the component. (inherited
from Component)
Tag <Layout> (p. 534) No details provided.
Tag <layoutName> (p. 535) No details provided.
Attribute BottomAttachment= (p. 536) Bottom attachment of the layout. (inherited from Component)
Attribute BottomOffset= (p. 537) Bottom offset related to the bottom attachment. (inherited
from Component)
Attribute ComponentType= (p. 538) Type of the component for the component. (inherited from
Component)
Attribute CustomCSSFile= (p. 539) Custom css file for the component layout. (inherited from
Component)
Attribute CustomHTMLFile= (p. 539) Custom html file for the component layout. (inherited from
Component)
Attribute CustomJSFile= (p. 540) Custom jscript file for the component layout. (inherited from
Component)
Attribute Height= (p. 541) Height value for the component. (inherited from Component)
Attribute HeightType= (p. 542) Height type for the component. (inherited from Component)
Attribute LeftAttachment= (p. 543) Left attachment of the layout. (inherited from Component)
Attribute LeftOffset= (p. 544) Left offset related to the left attachment. (inherited from
Component)
Attribute MaxHeight= (p. 545) Maximum height for the component. (inherited from
Component)
Attribute MaxWidth= (p. 546) Maximum width for the component. (inherited from
Component)
Attribute MinHeight= (p. 547) Minimum height for the component. (inherited from
Component)
Attribute MinWidth= (p. 548) Minimum width for the component. (inherited from
Component)
Attribute name= (p. 549) Name of the component. (inherited from Component)
ACT XML Tags
Attribute RightAttachment= (p. 549) Right attachment of the layout. (inherited from Component)
Attribute RightOffset= (p. 550) Right offset related to the right attachment. (inherited from
Component)
Attribute TopAttachment= (p. 551) Top attachment of the layout. (inherited from Component)
Attribute TopOffset= (p. 552) Top offset related to the top attachment. (inherited from
Component)
Attribute visible= (p. 553) Initial visibility of the component. (inherited from Component)
Attribute Width= (p. 554) Width value for the component. (inherited from Component)
Attribute WidthType= (p. 555) Width type for the component. (inherited from Component)
<Attributes>
Defines the set of attributes for the component. (inherited from Component)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Layout>
<PanelComponent>
Type
Ansys_ACT_Core_XmlDataModel_UI_Layout (p. 311)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_UI_Layout
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<layoutName>
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
Details
Description
None.
Name
layoutName
ValueName
None.
Public
True
TypeId
BottomAttachment=
Bottom attachment of the layout. (inherited from Component)
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
BottomAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
<PanelComponent>
MappedValues
None.
Public
True
Description
None.
TypeId
BottomOffset=
Bottom offset related to the bottom attachment. (inherited from Component)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
BottomOffset
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
ACT XML Tags
Description
None.
TypeId
ComponentType=
Type of the component for the component. (inherited from Component)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
ComponentType
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<PanelComponent>
CustomCSSFile=
Custom css file for the component layout. (inherited from Component)
Type
System_String
Remarks
Examples
None.
Details
Name
CustomCSSFile
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
CustomHTMLFile=
Custom html file for the component layout. (inherited from Component)
ACT XML Tags
Type
System_String
Remarks
Examples
None.
Details
Name
CustomHTMLFile
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
CustomJSFile=
Custom jscript file for the component layout. (inherited from Component)
Type
System_String
<PanelComponent>
Remarks
Examples
None.
Details
Name
CustomJSFile
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Height=
Height value for the component. (inherited from Component)
Type
System_Single
Remarks
None.
ACT XML Tags
Examples
None.
Details
Name
Height
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
HeightType=
Height type for the component. (inherited from Component)
Type
Remarks
None.
Examples
None.
<PanelComponent>
Details
Name
HeightType
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
LeftAttachment=
Left attachment of the layout. (inherited from Component)
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
ACT XML Tags
Name
LeftAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
LeftOffset=
Left offset related to the left attachment. (inherited from Component)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
LeftOffset
DefaultValue
None.
<PanelComponent>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
MaxHeight=
Maximum height for the component. (inherited from Component)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
MaxHeight
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
MaxWidth=
Maximum width for the component. (inherited from Component)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
MaxWidth
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<PanelComponent>
Public
True
Description
None.
TypeId
MinHeight=
Minimum height for the component. (inherited from Component)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
MinHeight
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
ACT XML Tags
TypeId
MinWidth=
Minimum width for the component. (inherited from Component)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
MinWidth
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<PanelComponent>
name=
Name of the component. (inherited from Component)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
RightAttachment=
Right attachment of the layout. (inherited from Component)
ACT XML Tags
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
RightAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
RightOffset=
Right offset related to the right attachment. (inherited from Component)
Type
System_Int32
<PanelComponent>
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
RightOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
TopAttachment=
Top attachment of the layout. (inherited from Component)
Type
System_String
Remarks
ACT XML Tags
Examples
None.
Details
Mandatory
False
Name
TopAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
TopOffset=
Top offset related to the top attachment. (inherited from Component)
Type
System_Int32
Remarks
None.
Examples
None.
<PanelComponent>
Details
Mandatory
False
Name
TopOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
visible=
Initial visibility of the component. (inherited from Component)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
ACT XML Tags
Name
visible
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
Width=
Width value for the component. (inherited from Component)
Type
System_Single
Remarks
None.
Examples
None.
Details
Name
Width
Mandatory
True
DefaultValue
None.
<PanelComponent>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
WidthType=
Width type for the component. (inherited from Component)
Type
Remarks
None.
Examples
None.
Details
Name
WidthType
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<parameter>
Class defining a single parameter definition for a task.
Remarks
None.
Examples
None.

<parameter>
Attribute control= (p. 580) Underlying data type of the parameter.
Attribute usage= (p. 583) Usage of the parameter.
<Attributes>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
<parameter>
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<parameter>
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<parameter>
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<parameter>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<parameter>
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnGenerateData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<parameter>
<OnHide>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnInit>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<parameter>
<OnMigrate>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnReady>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<parameter>
<OnRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnShow>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<parameter>
<OnSuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<parameter>
<Property>
Type
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
Details
DefaultValue
None.
Name
caption
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
<parameter>
Details
DefaultValue
None.
Name
class
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
DefaultValue
True
ACT XML Tags
Name
contextual
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
control=
Underlying data type of the parameter.
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
control
Mandatory
True
<parameter>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
icon
Mandatory
False
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
name
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<parameter>
Public
True
Description
None.
TypeId
usage=
Usage of the parameter.
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
usage
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
ACT XML Tags
TypeId
version=
Type
System_Int32
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
version
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<parameters>
<parameters>
Class defining the collection of task parameters.
Remarks
None.
Examples
None.
Tag <Parameter> (p. 585) No details

provided.
<Parameter>
Type
Ansys_ACT_Core_XmlDataModel_Parameter (p. 556)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Parameter
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
ACT XML Tags
TypeId
<platform>
This class defines the Platform XML Tag.
Remarks
None.
Examples
None.
Attribute name= (p. 586) The platform name. May be "Win64" or

"Linux64"
Attribute path= (p. 587) The platform-supported path (e.g., to an
exe)
name=
The platform name. May be "Win64" or "Linux64"
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
name
Mandatory
True
<platform>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
path=
The platform-supported path (e.g., to an exe)
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
path
Mandatory
True
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Presentations>
Remarks
None.
Examples
None.
Tag <ScenePresentation> (p. 588) No details

provided.
provided.
<ScenePresentation>
Type
Ansys_ACT_Core_XmlDataModel_Application_ScenePresentation (p. 850)
Remarks
None.
Examples
None.
<Presentations>
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_ScenePresentation
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Remarks
None.
Examples
None.
Tag <Callbacks> (p. 590) No details

provided.
Callback <OnReadInput> (p. 591) No details
provided.
Callback <OnSendBackData> (p. 592) No details
provided.
Callback <OnSendData> (p. 593) No details
provided.
Callback <OnWriteInput> (p. 594) No details
provided.
Tag <UserObjectConverter> (p. 595) No details
provided.
Attribute dataModel= (p. 596) No details
provided.
Attribute product= (p. 597) No details
provided.
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<OnReadInput>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
ActionCallback_IApplicationDataModel__StreamReader_
Name
OnReadInput
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnSendBackData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_object__IExtAPI_
Name
OnSendBackData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnSendData>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
ActionCallback_object__IExtAPI_
Name
OnSendData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnWriteInput>
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IApplicationDataModel__StreamWriter_
Name
OnWriteInput
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<UserObjectConverter>
Type
Ansys_ACT_Core_XmlDataModel_Application_UserObjectConverter (p. 1071)
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
dataModel=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
dataModel
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
product=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
product
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
<ProductTask>
Class defining a new user input application task.
Remarks
None.
Examples
None.
Tag <DataModelInOut> (p. 598) The panel associated to the task.

Attribute caption= (p. 599) The caption of the task. (inherited from
BaseTaskTag)
Attribute name= (p. 600) The name of the task. (inherited from
BaseTaskTag)
Attribute product= (p. 601) The panel associated to the task.
<DataModelInOut>
The panel associated to the task.
Type
Ansys_ACT_Core_XmlDataModel_Application_DataModelInOut (p. 106)
Remarks
None.
Examples
None.
<ProductTask>
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_DataModelInOut
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
The caption of the task. (inherited from BaseTaskTag)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Description
None.
Name
caption
DefaultValue
None.
DataDefinition
False
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
name=
The name of the task. (inherited from BaseTaskTag)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
<ProductTask>
MappedValues
None.
Public
True
TypeId
product=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
product
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
ACT XML Tags
TypeId
<program>
This class defines the Program XML Tag.
Remarks
None.
Examples
None.
Tag <Argument> (p. 602) The program's command-line

arguments.
Tag <Platform> (p. 603) The program's supported platforms.
<Argument>
The program's command-line arguments.
Type
Ansys_ACT_Core_XmlDataModel_Argument (p. 40)
Remarks
None.
Examples
None.
Details
MaxOccurence
-1
MinOccurence
0
Mandatory
False
ChildType
Ansys_ACT_Core_XmlDataModel_Argument
<projectdata>
RealParent
None.
TypeId
<Platform>
The program's supported platforms.
Type
Ansys_ACT_Core_XmlDataModel_Platform (p. 586)
Remarks
None.
Examples
None.
Details
MaxOccurence
-1
MinOccurence
1
Mandatory
True
ChildType
Ansys_ACT_Core_XmlDataModel_Platform
RealParent
None.
TypeId
<projectdata>
Remarks
None.
ACT XML Tags
Examples
None.
Tag <DataEntity> (p. 604) No details

provided.
<DataEntity>
Type
Ansys_ACT_Core_XmlDataModel_DataEntity (p. 121)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_DataEntity
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<property>
Class defining a property of any user object.
<property>
Remarks
None.
Examples
None.

PropertyBase)
ACT XML Tags
from PropertyBase)
PropertyBase)
from PropertyBase)
PropertyBase)
from PropertyBase)
from PropertyBase)
PropertyBase)
PropertyBase)
from PropertyBase)
PropertyBase)
<property>
from PropertyBase)
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<GetValue>
Type
Remarks
Examples
None.
Details
CallbackType
Name
GetValue
<property>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<help>
Type
System_String
Remarks
None.
Examples
None.
Details
Description
Name
help
ValueName
None.
ACT XML Tags
Public
True
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
<property>
TypeId
<IsVisible>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsVisible
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnActivate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnActivate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<property>
<OnAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<property>
<OnApply>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnApply
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<property>
<OnButtonClick>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnButtonClick
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnCancel>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnCancel
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<property>
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnHide>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<property>
<OnInit>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnJournalExecuting
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<property>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnJournalRecording
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnMigrate>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<property>
<OnRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnShow>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<property>
<OnValidate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnValidate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<SetValue>
Type
Remarks
Examples
None.
Details
CallbackType
Name
SetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<property>
<String2Value>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
String2Value
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<Value2String>
PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Value2String
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<property>
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
ACT XML Tags
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
control=
<property>
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
control
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
default=
Type
System_String
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
default
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
elementtype=
Type
System_String
Remarks
None.
<property>
Examples
None.
Details
Mandatory
False
Name
elementtype
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
isparameter=
Type
System_Boolean
Remarks
None.
Examples
None.
ACT XML Tags
Details
Mandatory
False
Name
isparameter
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
keytype=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
<property>
Name
keytype
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
needupdate=
PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
needupdate
DefaultValue
True
DataDefinition
False
<property>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
parameterizable=
PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
parameterizable
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
persistent=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
persistent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
<property>
MappedValues
None.
Public
True
Description
None.
TypeId
readonly=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
readonly
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
ACT XML Tags
Description
None.
TypeId
unit=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
unit
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<property>
valuetype=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
valuetype
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
visible=
ACT XML Tags
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
visible
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
visibleon=
Type
<propertygroup>
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
visibleon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
<propertygroup>
Class defining a collection of properties.
Remarks
None.
ACT XML Tags
Examples
None.

PropertyBase)
<propertygroup>
from PropertyBase)
PropertyBase)
from PropertyBase)
PropertyBase)
Attribute display= (p. 676) Display type of the property group.
from PropertyBase)
from PropertyBase)
PropertyBase)
PropertyBase)
from PropertyBase)
PropertyBase)
from PropertyBase)
ACT XML Tags

<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
<propertygroup>
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<GetValue>
Type
Remarks
Examples
None.
Details
CallbackType
Name
GetValue
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<help>
Type
System_String
Remarks
None.
Examples
None.
Details
Description
Name
help
ValueName
None.
<propertygroup>
Public
True
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
ACT XML Tags
TypeId
<IsVisible>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsVisible
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<propertygroup>
<OnActivate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnActivate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<propertygroup>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnApply>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnApply
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<propertygroup>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnButtonClick>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnButtonClick
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<propertygroup>
<OnCancel>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnCancel
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<propertygroup>
<OnHide>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnInit>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<propertygroup>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnJournalExecuting
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnJournalRecording
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<propertygroup>
<OnMigrate>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<propertygroup>
<OnShow>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnValidate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnValidate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<propertygroup>
<Property>
Type
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<SetValue>
Type
Remarks
Examples
None.
ACT XML Tags
Details
CallbackType
Name
SetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<String2Value>
Type
Remarks
None.
Examples
None.
<propertygroup>
Details
CallbackType
Name
String2Value
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Value2String>
PropertyBase)
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
Value2String
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
<propertygroup>
Details
Name
caption
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
ACT XML Tags
Details
Name
class
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
control=
Type
System_String
Remarks
None.
Examples
None.
Details
Name
control
<propertygroup>
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
default=
Type
System_String
Remarks
None.
Examples
None.
Details
Name
default
Mandatory
False
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
display=
Display type of the property group.
Type
Remarks
None.
Examples
None.
Details
Name
display
Mandatory
False
DefaultValue
Caption
DataDefinition
False
AllowedValues
None.
<propertygroup>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
elementtype=
Type
System_String
Remarks
None.
Examples
None.
Details
Name
elementtype
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
isparameter=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
isparameter
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
<propertygroup>
TypeId
keytype=
Type
System_String
Remarks
None.
Examples
None.
Details
Name
keytype
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
needupdate=
PropertyBase)
<propertygroup>
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
needupdate
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
parameterizable=
PropertyBase)
Type
System_Boolean
ACT XML Tags
Remarks
None.
Examples
None.
Details
Name
parameterizable
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
persistent=
Type
System_Boolean
Remarks
None.
<propertygroup>
Examples
None.
Details
Name
persistent
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
readonly=
Type
System_Boolean
Remarks
None.
Examples
None.
ACT XML Tags
Details
Name
readonly
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
unit=
Type
System_String
Remarks
None.
Examples
None.
Details
Name
unit
<propertygroup>
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
valuetype=
Type
System_String
Remarks
None.
Examples
None.
Details
Name
valuetype
Mandatory
False
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
visible=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
visible
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
<propertygroup>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
visibleon=
Type
Remarks
None.
Examples
None.
Details
Name
visibleon
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
<propertytable>
Class encapsulating a list of child properties under one table.
Remarks
None.
Examples
None.

<propertytable>
PropertyBase)
from PropertyBase)
Attribute allowempty= (p. 715) Unit type of the property (for float control).
PropertyBase)
from PropertyBase)
Attribute control= (p. 718) Control type of the property table (e.g. tabulardata,
custom, etc.)
PropertyBase)
Attribute display= (p. 719) Display type of the property table.
from PropertyBase)
from PropertyBase)
ACT XML Tags

PropertyBase)
PropertyBase)
from PropertyBase)
PropertyBase)
from PropertyBase)
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
<propertytable>
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
ACT XML Tags
<GetValue>
Type
Remarks
Examples
None.
Details
CallbackType
Name
GetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<propertytable>
<help>
Type
System_String
Remarks
None.
Examples
None.
Details
Description
Name
help
ValueName
None.
Public
True
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<IsVisible>
Type
Remarks
None.
Examples
None.
<propertytable>
Details
CallbackType
Name
IsVisible
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnActivate>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnActivate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnAdd>
Type
Remarks
None.
Examples
None.
<propertytable>
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnApply>
Type
Remarks
None.
Examples
None.
<propertytable>
Details
CallbackType
Name
OnApply
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnButtonClick>
Type
Remarks
None.
Examples
None.
<propertytable>
Details
CallbackType
Name
OnButtonClick
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnCancel>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnCancel
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
<propertytable>
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnInit>
Type
Remarks
None.
Examples
None.
<propertytable>
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnJournalExecuting
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
<propertytable>
Details
CallbackType
Name
OnJournalRecording
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
<propertytable>
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnValidate>
Type
Remarks
None.
Examples
None.
<propertytable>
Details
CallbackType
Name
OnValidate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Property>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<SetValue>
Type
Remarks
Examples
None.
Details
CallbackType
Name
SetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
<propertytable>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<String2Value>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
String2Value
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
ACT XML Tags
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Value2String>
PropertyBase)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Value2String
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
<propertytable>
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
allowempty=
Unit type of the property (for float control).
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
allowempty
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Name
caption
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
<propertytable>
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Name
class
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
ACT XML Tags
TypeId
control=
Control type of the property table (e.g. tabulardata, custom, etc.)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
control
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<propertytable>
default=
Type
System_String
Remarks
None.
Examples
None.
Details
Name
default
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
display=
Display type of the property table.
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
display
DefaultValue
Worksheet
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
elementtype=
Type
System_String
<propertytable>
Remarks
None.
Examples
None.
Details
Name
elementtype
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
isparameter=
Type
System_Boolean
Remarks
None.
ACT XML Tags
Examples
None.
Details
Name
isparameter
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
keytype=
Type
System_String
Remarks
None.
Examples
None.
<propertytable>
Details
Name
keytype
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
ACT XML Tags
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
needupdate=
PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
needupdate
Mandatory
False
<propertytable>
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
parameterizable=
PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
parameterizable
Mandatory
False
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
persistent=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
persistent
Mandatory
False
DefaultValue
None.
DataDefinition
False
<propertytable>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
readonly=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
readonly
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
unit=
Type
System_String
Remarks
None.
Examples
None.
Details
Name
unit
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
<propertytable>
Description
None.
TypeId
valuetype=
Type
System_String
Remarks
None.
Examples
None.
Details
Name
valuetype
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
visible=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
visible
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
visibleon=
<Result>
Type
Remarks
None.
Examples
None.
Details
Name
visibleon
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
<Result>
Class defining a result.
Remarks
None.
ACT XML Tags
Examples
None.

Callback <Evaluate> (p. 739) Callback that is invoked when the step described
by stepInfo is evaluated.
Callback <GetFieldCount> (p. 740) Callback that is invoked to get the number of fields
(ie components) for a given element or node ID.
Callback <GetValue> (p. 741) Callback that is invoked to get the values
associated to a node or an element given by its
ID.
Callback <OnEndEval> (p. 748) Callback that is invoked at the end of the
evaluation process for a given step.
Callback <OnEndPost> (p. 749) Callback that is invoked at the end of the post
process.
<Result>
Callback <OnStartEval> (p. 757) Callback that is invoked when the evaluation
process for a given step starts.
Callback <OnStartPost> (p. 758) Callback that is invoked when the post process
starts.
Attribute averaging= (p. 761) Averaging of the result.
Attribute hasimaginary= (p. 765) Indicates whether the result supports imaginary
values.
Attribute iscontactresult= (p. 767) Indicates whether the result object should be
considered as a contact result or not.
Attribute location= (p. 768) Location of the result.
Attribute timehistory= (p. 769) Indicates whether the time history has to be
calculated.
Attribute type= (p. 770) Type of the result.
Attribute unit= (p. 771) Unit used by the contour display.
<Action>
Type
List_Action_
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
None.
Name
Action
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Attributes>
Type
<Result>
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
ACT XML Tags
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
<Result>
RealParent
Mandatory
False
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
ACT XML Tags
Mandatory
False
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
<Result>
TypeId
<Evaluate>
Callback that is invoked when the step described by stepInfo is evaluated.
Type
Ansys_ACT_Core_XmlDataModel_CallbackEvaluate (p. 49)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_Evaluate
Name
Evaluate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<GetFieldCount>
Callback that is invoked to get the number of fields (ie components) for a given element or node ID.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetFieldCount
Name
GetFieldCount
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Result>
<GetValue>
Callback that is invoked to get the values associated to a node or an element given by its ID.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetValue
Name
GetValue
Public
True
Obsolete
True
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Result>
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Result>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Result>
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnEndEval>
Callback that is invoked at the end of the evaluation process for a given step.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_StartEndEval
Name
OnEndEval
Public
True
Obsolete
True
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Result>
<OnEndPost>
Callback that is invoked at the end of the post process.
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserResult_
Name
OnEndPost
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnGenerateData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Result>
<OnHide>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnInit>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Result>
<OnMigrate>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnReady>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Result>
<OnRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnShow>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Result>
<OnStartEval>
Callback that is invoked when the evaluation process for a given step starts.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_StartEndEval
Name
OnStartEval
Public
True
Obsolete
True
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnStartPost>
Callback that is invoked when the post process starts.
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserResult_
Name
OnStartPost
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Result>
<OnSuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Result>
<Property>
Type
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
averaging=
Averaging of the result.
Type
Ansys_ACT_Interfaces_Post_ResultAveragingEnum
Remarks
None.
Examples
None.
ACT XML Tags
Details
Mandatory
False
Name
averaging
DefaultValue
Unaverage
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
<Result>
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
ACT XML Tags
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
<Result>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
hasimaginary=
Indicates whether the result supports imaginary values.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
hasimaginary
DefaultValue
True
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<Result>
Public
True
Description
None.
TypeId
iscontactresult=
Indicates whether the result object should be considered as a contact result or not.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
iscontactresult
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
ACT XML Tags
TypeId
location=
Location of the result.
Type
Ansys_ACT_Interfaces_Post_ResultLocationEnum
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
location
DefaultValue
None.
DataDefinition
False
AllowedValues
System.String[]
MultipleValue
False
MappedValues
System.Object[]
Public
True
Description
None.
TypeId
<Result>
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
timehistory=
Indicates whether the time history has to be calculated.
ACT XML Tags
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
timehistory
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
type=
Type of the result.
Type
Ansys_ACT_Interfaces_Post_ResultTypeEnum
<Result>
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
type
DefaultValue
None.
DataDefinition
False
AllowedValues
System.String[]
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
unit=
Unit used by the contour display.
Type
System_String
Remarks
None.
ACT XML Tags
Examples
None.
Details
Mandatory
False
Name
unit
DefaultValue
Dimensionless
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Type
System_Int32
Remarks
None.
Examples
None.
<rsmjob>
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<rsmjob>
This class defines an rsm job.
Remarks
None.
Examples
None.

ACT XML Tags
Tag <InputFile> (p. 779) The job input files.
Callback <oncreatejobinput> (p. 785) This callback handles the generation of all input
files defined on the rsm job.
Callback <onjobcancellation> (p. 790) This callback handles a user-invoked job
cancellation.
Callback <onjobreconnect> (p. 791) This callback handles the reconnection of the rsm
job. The implementor must update the task data
model to deem the task as up-to-date.
Callback <onjobstatus> (p. 792) This callback handles the status polling engaged
by the Framework. Return True to indicate the job
has completed.
Tag <OutputFile> (p. 799) The job output files.
<rsmjob>
Tag <Program> (p. 799) The programs to run by the rsm job. Currently
only one program per job allowed.
Attribute deletefiles= (p. 803) Indicates whether ACT should delete all rsmJob
input and output files upon successful completion
or job cancellation.
<Attributes>
Type
Remarks
None.
Examples
None.
Details
MaxOccurence
-1
MinOccurence
0
Mandatory
False
ChildType
None.
RealParent
None.
ACT XML Tags
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
MaxOccurence
-1
MinOccurence
0
Mandatory
False
ChildType
None.
RealParent
None.
TypeId
<CanAdd>
Type
Remarks
None.
<rsmjob>
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanDuplicate>
Type
Remarks
None.
ACT XML Tags
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<CanRemove>
Type
Remarks
None.
<rsmjob>
Examples
None.
Details
CallbackType
Mandatory
False
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<InputFile>
The job input files.
Type
Ansys_ACT_Core_XmlDataModel_InputFile (p. 267)
Remarks
None.
ACT XML Tags
Examples
None.
Details
MaxOccurence
-1
MinOccurence
0
Mandatory
False
ChildType
Ansys_ACT_Core_XmlDataModel_InputFile
RealParent
None.
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
IsValid
<rsmjob>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnAdd
Public
True
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
<rsmjob>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ACT XML Tags
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
<rsmjob>
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<oncreatejobinput>
This callback handles the generation of all input files defined on the rsm job.
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__List_string__
Mandatory
True
Name
oncreatejobinput
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
1
ACT XML Tags
MaxOccurence
-1
RealParent
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
<rsmjob>
RealParent
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
ACT XML Tags
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<rsmjob>
<OnInit>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
ACT XML Tags
<onjobcancellation>
This callback handles a user-invoked job cancellation.
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__List_string___List_string__
Mandatory
True
Name
onjobcancellation
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
1
MaxOccurence
-1
RealParent
TypeId
<rsmjob>
<onjobreconnect>
This callback handles the reconnection of the rsm job. The implementor must update the task data
model to deem the task as up-to-date.
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__List_string__
Mandatory
True
Name
onjobreconnect
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
1
MaxOccurence
-1
RealParent
TypeId
ACT XML Tags
<onjobstatus>
This callback handles the status polling engaged by the Framework. Return True to indicate the job
has completed.
Type
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__List_string___bool_
Mandatory
True
Name
onjobstatus
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
1
MaxOccurence
-1
RealParent
TypeId
<rsmjob>
<OnMigrate>
Type
Remarks
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
ACT XML Tags
<OnReady>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<rsmjob>
<OnRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
ACT XML Tags
<OnShow>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<rsmjob>
<OnSuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
ACT XML Tags
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Mandatory
False
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
TypeId
<rsmjob>
<OutputFile>
The job output files.
Type
Ansys_ACT_Core_XmlDataModel_OutputFile (p. 522)
Remarks
None.
Examples
None.
Details
MaxOccurence
-1
MinOccurence
0
Mandatory
False
ChildType
Ansys_ACT_Core_XmlDataModel_OutputFile
RealParent
None.
TypeId
<Program>
The programs to run by the rsm job. Currently only one program per job allowed.
Type
Ansys_ACT_Core_XmlDataModel_Program (p. 602)
Remarks
None.
Examples
None.
ACT XML Tags
Details
MaxOccurence
1
MinOccurence
1
Mandatory
True
ChildType
Ansys_ACT_Core_XmlDataModel_Program
RealParent
None.
TypeId
<Property>
Type
Remarks
None.
Examples
None.
Details
MaxOccurence
-1
MinOccurence
0
Mandatory
False
ChildType
RealParent
None.
<rsmjob>
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
caption
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
class=
Type
System_String
Remarks
Examples
None.
Details
DefaultValue
None.
Name
class
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<rsmjob>
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
DefaultValue
True
Name
contextual
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
deletefiles=
Indicates whether ACT should delete all rsmJob input and output files upon successful completion
or job cancellation.
ACT XML Tags
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Name
deletefiles
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Type
System_String
<rsmjob>
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
icon
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
ACT XML Tags
Examples
None.
Details
DefaultValue
None.
Name
name
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Type
System_Int32
Remarks
None.
Examples
None.
<Sampling>
Details
DefaultValue
None.
Name
version
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Sampling>
Class defining a DesignXplorer Sampling.
Remarks
None.
Examples
None.
Tag <Attributes> (p. 810) No details provided. (inherited from

SimEntity)
Tag <Callbacks> (p. 811) No details provided. (inherited from
SimEntity)
ACT XML Tags
Callback <CanAdd> (p. 812) Callback that is invoked to determine

whether the object can be added.
Callback <CanDuplicate> (p. 813) Callback that is invoked to determine if
the object can be duplicated. (inherited
from SimEntity)
Callback <CanRemove> (p. 814) Callback that is invoked to determine if
the object can be removed. (inherited
from SimEntity)
Callback <CanRun> (p. 815) Callback that is invoked to indicate
whether the optimizer (or sampling) is
able to process the optimization (design
of experiments) study with its current
configuration. (inherited from
DesignExplorer)
Callback <Configuration> (p. 816) Callback that is invoked to return a
userreadable string summarizing the
current configuration of the optimizer
(or the sampling). (inherited from
DesignExplorer)
Callback <Description> (p. 817) Callback that is invoked to return a
optimizer and its specific capabilities.
Callback <InputParametersEdited> (p. 818) Callback that is invoked when the
properties of input parameters have
changed. (inherited from
DesignExplorer)
Callback <IsValid> (p. 819) Callback that is invoked to determine if
the object is valid. (inherited from
SimEntity)
Callback <MethodPropertiesEdited> (p. 820) Callback that is invoked when the
properties of the optimization method
have changed. (inherited from
DesignExplorer)
Callback <OnAdd> (p. 821) Callback that is invoked when the object
is newly added. (inherited from
SimEntity)
Callback <OnAfterGeometryUpdate> (p. 822) Callback that is invoked when the
geometry has been updated. (inherited
from SimEntity)
Callback <OnBodySuppressStateChange> (p. 823) Callback that is invoked when the body
suppress state changse. (inherited from
SimEntity)
Callback <OnClearData> (p. 824) Callback that is invoked when object
data are cleared. (inherited from
SimEntity)
<Sampling>
Callback <OnCreate> (p. 825) Callback that is invoked to provide an

instance of IOptimizationMethod (or
ISamplingMethod). (inherited from
DesignExplorer)
Callback <OnDuplicate> (p. 826) Callback that is invoked when the object
is duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 827) Callback that is invoked when object
data are generated. (inherited from
SimEntity)
Callback <OnHide> (p. 828) Callback that is invoked when the object
is hidden. (inherited from SimEntity)
Callback <OnInit> (p. 829) Callback that is invoked when the object
is initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 830) Callback that is invoked when the object
version has been changed. (inherited
from SimEntity)
Callback <OnReady> (p. 831) Callback that is invoked when the
application is fully loaded and in a
"ready" state. (Inherited from SimEntity)
Callback <OnRelease> (p. 832) Callback that is invoked to release the
IOptimizationMethod (or the
ISamplingMethod) instance. (inherited
Callback <OnRemove> (p. 833) Callback that is invoked when the object
is removed. (inherited from SimEntity)
Callback <OnShow> (p. 834) Callback that is invoked when the object
is shown. (inherited from SimEntity)
Callback <OnSuppress> (p. 835) Callback that is invoked when the object
is suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 836) Callback that is invoked when the object
is unsuppressed. (inherited from
SimEntity)
Tag <Property> (p. 837) No details provided. (inherited from
SimEntity)
Callback <QuickHelp> (p. 837) Callback that is invoked to return a
user-readable string helping to
understand the state of the optimizer
(or the sampling) when CanRun is false.
Callback <Status> (p. 838) Callback that is invoked to return a
status of the optimization (or the
sampling) resolution. (inherited from
DesignExplorer)
Attribute caption= (p. 839) Caption of the object. (inherited from
SimEntity)
ACT XML Tags
Attribute class= (p. 840) Class name of the controller of the

object. (inherited from SimEntity)
Attribute contextual= (p. 841) Indicates whether the object has to be
displayed in the contextual menu.
Attribute CustomTable= (p. 842) Supports custom table points.
Attribute icon= (p. 843) Icon for the object. (inherited from
SimEntity)
Attribute logfile= (p. 844) Provides messages to generate a log file.
Attribute maximumnumberofdoublelistparameters= (p. 845) Indicates the maximum number of
double list parameters supported.
Attribute maximumnumberofdoubleparameters= (p. 846) Indicates the maximum number of
double parameters supported. (inherited
Attribute maximumnumberofinputparameters= (p. 847) Indicates the maximum number of input
parameters supported. (inherited from
DesignExplorer)
Attribute maximumnumberofintegerlistparameters= (p. 848) Indicates the maximum number of
integer list parameters supported.
Attribute name= (p. 848) Name of the object. (inherited from
SimEntity)
Attribute version= (p. 849) Version of the object. (inherited from
SimEntity)
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
<Sampling>
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
ACT XML Tags
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Sampling>
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Sampling>
<CanRun>
Callback that is invoked to indicate whether the optimizer (or sampling) is able to process the optim-
ization (design of experiments) study with its current configuration. (inherited from DesignExplorer)
Type
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__bool_
Name
CanRun
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<Configuration>
Callback that is invoked to return a userreadable string summarizing the current configuration of the
optimizer (or the sampling). (inherited from DesignExplorer)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Configuration
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Sampling>
<Description>
Callback that is invoked to return a user-readable string describing the optimizer and its specific
capabilities. (inherited from DesignExplorer)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Description
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<InputParametersEdited>
Callback that is invoked when the properties of input parameters have changed. (inherited from De-
signExplorer)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
InputParametersEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Sampling>
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<MethodPropertiesEdited>
Callback that is invoked when the properties of the optimization method have changed. (inherited
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
MethodPropertiesEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Sampling>
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Sampling>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Sampling>
<OnCreate>
Callback that is invoked to provide an instance of IOptimizationMethod (or ISamplingMethod). (inherited
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Sampling>
<OnGenerateData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnHide>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Sampling>
<OnInit>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnMigrate>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Sampling>
<OnReady>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnRelease>
Callback that is invoked to release the IOptimizationMethod (or the ISamplingMethod) instance. (in-
herited from DesignExplorer)
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRelease
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Sampling>
<OnRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnShow>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Sampling>
<OnSuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Sampling>
<Property>
Type
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<QuickHelp>
Callback that is invoked to return a user-readable string helping to understand the state of the optim-
izer (or the sampling) when CanRun is false. (inherited from DesignExplorer)
Type
Remarks
None.
ACT XML Tags
Examples
None.
Details
CallbackType
Name
QuickHelp
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Status>
Callback that is invoked to return a user-readable string describing the status of the optimization (or
the sampling) resolution. (inherited from DesignExplorer)
Type
Remarks
None.
<Sampling>
Examples
None.
Details
CallbackType
Name
Status
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
caption=
Type
System_String
Remarks
None.
ACT XML Tags
Examples
None.
Details
DefaultValue
None.
DataDefinition
False
Name
caption
Mandatory
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
<Sampling>
Examples
None.
Details
DefaultValue
None.
DataDefinition
False
Name
class
Mandatory
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
ACT XML Tags
Details
DefaultValue
True
DataDefinition
False
Name
contextual
Mandatory
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
CustomTable=
Supports custom table points.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
<Sampling>
DataDefinition
True
Name
CustomTable
Mandatory
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
DataDefinition
False
Name
icon
ACT XML Tags
Mandatory
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
logfile=
Provides messages to generate a log file. (inherited from DesignExplorer)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
DataDefinition
False
Name
logfile
Mandatory
False
AllowedValues
None.
<Sampling>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
maximumnumberofdoublelistparameters=
Indicates the maximum number of double list parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Remarks
None.
Examples
None.
Details
DefaultValue
100
DataDefinition
False
Name
maximumnumberofdoublelistparameters
Mandatory
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
maximumnumberofdoubleparameters=
Indicates the maximum number of double parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Remarks
None.
Examples
None.
Details
DefaultValue
100
DataDefinition
False
Name
maximumnumberofdoubleparameters
Mandatory
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
<Sampling>
TypeId
maximumnumberofinputparameters=
Indicates the maximum number of input parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Remarks
None.
Examples
None.
Details
DefaultValue
100
DataDefinition
False
Name
maximumnumberofinputparameters
Mandatory
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
maximumnumberofintegerlistparameters=
Indicates the maximum number of integer list parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Remarks
None.
Examples
None.
Details
DefaultValue
100
DataDefinition
False
Name
maximumnumberofintegerlistparameters
Mandatory
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
<Sampling>
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
DataDefinition
False
Name
name
Mandatory
True
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Type
System_Int32
ACT XML Tags
Remarks
None.
Examples
None.
Details
DefaultValue
None.
DataDefinition
False
Name
version
Mandatory
True
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Scene>
Remarks
None.
<Scene>
Examples
None.
IronPython extension script. (inherited from Presentation)
Callback <OnAdd> (p. 852) No details provided. (inherited from Presentation)
Callback <OnDelete> (p. 853) No details provided. (inherited from Presentation)
Callback <OnHighlight> (p. 854) No details provided. (inherited from Presentation)
Callback <OnUnhighlight> (p. 855) No details provided. (inherited from Presentation)
Callback <OnUpdate> (p. 856) No details provided. (inherited from Presentation)
Attribute allowHighlight= (p. 857) No details provided. (inherited from Presentation)
Attribute userObject= (p. 857) No details provided. (inherited from Presentation)
Attribute visibility= (p. 858) No details provided. (inherited from Presentation)
<Callbacks>
Presentation)
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
ACT XML Tags
Mandatory
False
TypeId
<OnAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
<Scene>
TypeId
<OnDelete>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDelete
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnHighlight>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHighlight
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Scene>
<OnUnhighlight>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUnhighlight
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnUpdate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUpdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Scene>
allowHighlight=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
allowHighlight
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
userObject=
ACT XML Tags
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
userObject
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
visibility=
Type
Ansys_ACT_Interfaces_Presentations_VisibilityOptions
<script>
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
visibility
DefaultValue
Always
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<script>
Specifies the IronPython script referenced by the extension.
Remarks
None.
ACT XML Tags
Examples
None.
Attribute compiled= (p. 860) Specifies whether the script will be compiled as a
binary file.
Attribute src= (p. 861) Name of the Python script file.
compiled=
Specifies whether the script will be compiled as a binary file.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
compiled
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
<script>
Description
None.
TypeId
src=
Name of the Python script file.
Type
System_String
Remarks
By default, all folders referenced by this attribute are relatives to the folder of the extension.
Examples
None.
Details
Mandatory
False
Name
src
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
<separator>
Class defining the separator for items in a toolbar.
Remarks
None.
Examples
None.
<simdata>
Class defining a general section that stores all user object definitions.
Remarks
None.
Examples
None.
Tag <Load> (p. 862) No details provided.

Tag <Udf> (p. 863) No details provided.
using '|').
<Load>
Type
Ansys_ACT_Core_XmlDataModel_Load (p. 321)
Remarks
None.
Examples
None.
<simdata>
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Load
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Udf>
Type
Ansys_ACT_Core_XmlDataModel_Udf (p. 1031)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Udf
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
ACT XML Tags
TypeId
context=
Context or combination of contexts (separated using '|').
Type
Remarks
Examples
None.
Details
Mandatory
True
Name
context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
<Solver>
<Solver>
Class specifying a third-party solver to be used in the simulation.
Remarks
None.
Examples
None.

Callback <GetFiles> (p. 871) Callback that is invoked to return a list of file
strings used by a custom solver.
Callback <GetReader> (p. 872) Callback that is invoked to get the reader class
name and associated options.
Callback <GetSteps> (p. 873) Callback that is invoked to get the list of time
steps (or frequencies) that were computed during
the solve and are available for the post-processing.
Callback <IsAnalysisValid> (p. 874) Callback that is invoked to determine whether the
analysis is valid.
Callback <OnBeforeSolve> (p. 878) Callback that is invoked before the solve process.
Callback <OnCheckResults> (p. 880) Callback that is invoked before any post-processing
evaluation.
ACT XML Tags
Callback <OnSolve> (p. 890) Callback that is invoked when the solve process
is run.
Callback <OnWriteInputFile> (p. 893) Callback that is invoked to write the solver input
file.
Attribute analysis= (p. 894) Type of analysis.
Attribute evaluateFunctionLoads= (p. 898) Name of the toolbox.
Attribute physics= (p. 901) Type of physics.
Attribute toolbox= (p. 902) Name of the toolbox.
<Attributes>
Type
<Solver>
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
ACT XML Tags
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
<Solver>
RealParent
Mandatory
False
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
ACT XML Tags
Mandatory
False
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
<Solver>
TypeId
<GetFiles>
Callback that is invoked to return a list of file strings used by a custom solver.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetFiles
Name
GetFiles
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<GetReader>
Callback that is invoked to get the reader class name and associated options.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetReader
Name
GetReader
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Solver>
<GetSteps>
Callback that is invoked to get the list of time steps (or frequencies) that were computed during the
solve and are available for the post-processing.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSteps
Name
GetSteps
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<IsAnalysisValid>
Callback that is invoked to determine whether the analysis is valid.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsSolverAnalysisValid
Name
IsAnalysisValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Solver>
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Solver>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnBeforeSolve>
Callback that is invoked before the solve process.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBeforeSolve
Name
OnBeforeSolve
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Solver>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnCheckResults>
Callback that is invoked before any post-processing evaluation.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnCheckResults
Name
OnCheckResults
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Solver>
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Solver>
<OnGenerateData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnHide>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Solver>
<OnInit>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnMigrate>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Solver>
<OnReady>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Solver>
<OnShow>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnSolve>
Callback that is invoked when the solve process is run.
Type
Ansys_ACT_Core_XmlDataModel_CallbackOnSolve (p. 64)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSolve
Name
OnSolve
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Solver>
<OnSuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Solver>
<OnWriteInputFile>
Callback that is invoked to write the solver input file.
Type
Remarks
This callback is called after "OnBeforeSolve" and before "OnSolve" in a full solve process.
If the user ask only to write the input file, the callback will be called after "OnBeforeSolve".
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnWriteInputFile
Name
OnWriteInputFile
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<Property>
Type
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
analysis=
Type of analysis.
Type
System_String
Remarks
None.
Examples
None.
<Solver>
Details
Mandatory
True
Name
analysis
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
ACT XML Tags
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
<Solver>
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
evaluateFunctionLoads=
Name of the toolbox.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
evaluateFunctionLoads
DefaultValue
True
DataDefinition
False
AllowedValues
None.
<Solver>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
<Solver>
TypeId
physics=
Type of physics.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
physics
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
toolbox=
Name of the toolbox.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
toolbox
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
<StandardAction>
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<StandardAction>
Remarks
None.
ACT XML Tags
Examples
None.
Attribute actionId= (p. 904) No details

provided.
Attribute caption= (p. 905) No details
provided.
Attribute name= (p. 906) No details
provided.
actionId=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
actionId
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
<StandardAction>
MappedValues
None.
Public
True
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
ACT XML Tags
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
<Step>
<Step>
Class defining a step in a guided process a (wizard or AIM custom template).
Remarks
None.
Examples
None.

Tag <ComponentData> (p. 913) Data of the components in the step's layout.
Tag <ComponentStyle> (p. 913) Styles of the components in the step's layout.
Tag <Description> (p. 914) Gets or sets the description of the step.
Callback <oncreate> (p. 920) No details provided.
ACT XML Tags
Callback <onrefresh> (p. 927) Callback that is invoked when the step is
initialized.
Callback <onreset> (p. 929) Callback that is invoked when we return to the
previous step.
Callback <onupdate> (p. 933) Callback that is invoked when the step is finalized.
Attribute Context= (p. 936) Gets or sets the context name.
Attribute Enabled= (p. 938) Gets or sets the Enabled flag.
Attribute helpFile= (p. 939) File containing help HTML content.
Attribute Layout= (p. 941) Gets or sets the layout to use for this step.
<Attributes>
Type
Remarks
None.
Examples
None.
<Step>
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
ACT XML Tags
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Step>
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Step>
<ComponentData>
Data of the components in the step's layout.
Type
Ansys_ACT_Core_XmlDataModel_ComponentData (p. 89)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<ComponentStyle>
Styles of the components in the step's layout.
Type
Ansys_ACT_Core_XmlDataModel_ComponentStyle (p. 97)
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Description>
Gets or sets the description of the step.
Type
System_String
Remarks
None.
Examples
None.
Details
Description
None.
Name
Description
ValueName
None.
Public
True
TypeId
<Step>
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Step>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Step>
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<oncreate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IWizardStep_
Name
oncreate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Step>
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnGenerateData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Step>
<OnHide>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnInit>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Step>
<OnMigrate>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnReady>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Step>
<onrefresh>
Callback that is invoked when the step is initialized.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
onrefresh
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Step>
<onreset>
Callback that is invoked when we return to the previous step.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
onreset
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnShow>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Step>
<OnSuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Step>
<onupdate>
Callback that is invoked when the step is finalized.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
onupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<Property>
Type
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
<Step>
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
ACT XML Tags
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Context=
Gets or sets the context name.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
<Step>
Name
Context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Enabled=
Gets or sets the Enabled flag.
Type
System_Boolean
Remarks
This flag is true by default.
Examples
None.
Details
Mandatory
False
Name
Enabled
DefaultValue
True
DataDefinition
False
AllowedValues
None.
<Step>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
helpFile=
File containing help HTML content.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
helpFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
<Step>
TypeId
Layout=
Gets or sets the layout to use for this step.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
Layout
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
<Target>
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Target>
Class defining the target location for the object.
Remarks
None.
ACT XML Tags
Examples
None.
Attribute location= (p. 944) Sub-type of the target location when

ype==Analysis.
Attribute name= (p. 945) Name of the parent.
Attribute type= (p. 946) Type of the target location.
location=
Sub-type of the target location when ype==Analysis.
Type
Ansys_ACT_Interfaces_UserObject_ObjectLocationEnum
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
location
DefaultValue
Default
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
<Target>
Description
None.
TypeId
name=
Name of the parent.
Type
System_String
Remarks
This is the name of an object defined in the extension XML file. Used only if type==UserObject.
Examples
None.
Details
Mandatory
False
Name
name
DefaultValue
Default
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
type=
Type of the target location.
Type
Ansys_ACT_Interfaces_UserObject_ObjectTypeEnum
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
type
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<task>
Class defining a task that encapsulates a single process or application.
<task>
Remarks
None.
Examples
None.

Callback <canconsumedata> (p. 951) Callback that is invoked for task
connection/consumption.
Tag <ContextMenus> (p. 954) The user-defined custom context menu entries.
Tag <Inputs> (p. 954) User-defined task input connections.
Callback <onclean> (p. 959) Callback that is invoked for task cleaning.
Callback <ondelete> (p. 961) Callback that is invoked for task deletion.
Callback <onedit> (p. 963) Callback that is invoked for task EDIT entry.
Callback <oninitialize> (p. 967) Callback that is invoked for task creation.
ACT XML Tags
Callback <onload> (p. 968) Callback that is invoked when a task is loaded
from disk.
Callback <onrefresh> (p. 971) Callback that is invoked for task refresh.
Callback <onreport> (p. 973) Callback that is invoked for task reporting.
Callback <onreset> (p. 974) Callback that is invoked for task reset.
Callback <onstatus> (p. 976) Callback that is invoked for task status.
Callback <onupdate> (p. 979) Callback that is invoked for task update.
Tag <Outputs> (p. 980) User-defined task output connections.
Tag <Parameters> (p. 980) User-defined parameters to be exposed on the
task.
Tag <RsmJob> (p. 982) List of task-level RSM Jobs.
Attribute editicon= (p. 985) Name of the icon to display when an onedit
callback is defined.
Attribute enableGenericTransfer= (p. 986) Indicates whether or not the task should expose
the general transfer type as an output.
<Attributes>
<task>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
<task>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<canconsumedata>
Callback that is invoked for task connection/consumption.
Type
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_object__IUserObject__bool_
Name
canconsumedata
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
ACT XML Tags
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
<task>
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
ACT XML Tags
RealParent
Mandatory
False
TypeId
<ContextMenus>
The user-defined custom context menu entries.
Type
Ansys_ACT_Core_XmlDataModel_ContextMenus (p. 102)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_ContextMenus
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Inputs>
User-defined task input connections.
Type
Ansys_ACT_Core_XmlDataModel_Inputs (p. 276)
<task>
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Inputs
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
<task>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
<task>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onclean>
Callback that is invoked for task cleaning.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
onclean
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
ACT XML Tags
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
<task>
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<ondelete>
Callback that is invoked for task deletion.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
ondelete
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
ACT XML Tags
RealParent
Mandatory
False
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
<task>
Mandatory
False
TypeId
<onedit>
Callback that is invoked for task EDIT entry.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
onedit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
ACT XML Tags
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<task>
<OnHide>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnInit>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<task>
<oninitialize>
Callback that is invoked for task creation.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
oninitialize
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<onload>
Callback that is invoked when a task is loaded from disk.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
onload
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<task>
<OnMigrate>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnReady>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<task>
<onrefresh>
Callback that is invoked for task refresh.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
onrefresh
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<task>
<onreport>
Callback that is invoked for task reporting.
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__object_
Name
onreport
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<onreset>
Callback that is invoked for task reset.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
onreset
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<task>
<OnShow>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<onstatus>
Callback that is invoked for task status.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
onstatus
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<task>
<OnSuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<task>
<onupdate>
Callback that is invoked for task update.
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
onupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<Outputs>
User-defined task output connections.
Type
Ansys_ACT_Core_XmlDataModel_Outputs (p. 524)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Outputs
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Parameters>
User-defined parameters to be exposed on the task.
Type
Ansys_ACT_Core_XmlDataModel_Parameters (p. 585)
Remarks
None.
Examples
None.
<task>
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Parameters
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Property>
Type
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
ACT XML Tags
TypeId
<RsmJob>
List of task-level RSM Jobs.
Type
Ansys_ACT_Core_XmlDataModel_RsmJob (p. 773)
Remarks
Currently only one entry is allowed.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_RsmJob
MinOccurence
0
MaxOccurence
1
RealParent
None.
Mandatory
False
TypeId
caption=
Type
System_String
Remarks
None.
<task>
Examples
None.
Details
Mandatory
False
DefaultValue
None.
Name
caption
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
ACT XML Tags
Examples
None.
Details
Mandatory
False
DefaultValue
None.
Name
class
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
<task>
Details
Mandatory
False
DefaultValue
True
Name
contextual
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
editicon=
Name of the icon to display when an onedit callback is defined.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
ACT XML Tags
DefaultValue
None.
Name
editicon
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
enableGenericTransfer=
Indicates whether or not the task should expose the general transfer type as an output.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
DefaultValue
True
Name
enableGenericTransfer
<task>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
DefaultValue
None.
Name
icon
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
DefaultValue
None.
Name
name
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<task>
Public
True
Description
None.
TypeId
version=
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
DefaultValue
None.
Name
version
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
ACT XML Tags
TypeId
<task>
Remarks
None.
Examples
None.
Attribute Message= (p. 990) No details

provided.
provided.
Attribute Pct= (p. 992) No details
provided.
Message=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
Message
DefaultValue
None.
<task>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Pct=
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
Pct
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<taskgroup>
Public
True
Description
None.
TypeId
<taskgroup>
Class defining a collection of tasks.
Remarks
None.
Examples
None.

Tag <IncludeGroup> (p. 999) The task group's List of nested task groups.
Tag <IncludeTask> (p. 999) List of tasks for the task group.
Callback <OnBodySuppressStateChange> (p. 1003)Callback that is invoked when the body suppress
ACT XML Tags
Attribute abbreviation= (p. 1015) Task group abbreviation used for directory and
naming purposes.
Attribute category= (p. 1017) Category to which the task group applies.
Attribute headertext= (p. 1020) The text to display in the both the toolbox and
the task group header block.
Attribute isparametricgroup= (p. 1022) Indicates whether the taskgroup operates only on
parameters.
<Attributes>
Type
Remarks
None.
<taskgroup>
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
ACT XML Tags
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
<taskgroup>
Mandatory
False
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
ACT XML Tags
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<taskgroup>
<IncludeGroup>
The task group's List of nested task groups.
Type
Ansys_ACT_Core_XmlDataModel_IncludeGroup (p. 257)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_IncludeGroup
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<IncludeTask>
List of tasks for the task group.
Type
Ansys_ACT_Core_XmlDataModel_IncludeTask (p. 261)
Remarks
None.
Examples
None.
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_IncludeTask
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
<taskgroup>
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnAdd>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
ACT XML Tags
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
<taskgroup>
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
ACT XML Tags
RealParent
Mandatory
False
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
<taskgroup>
Mandatory
False
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
ACT XML Tags
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<taskgroup>
<OnHide>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnInit>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<taskgroup>
<OnMigrate>
Type
Remarks
Examples
None.
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnReady>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<taskgroup>
<OnRemove>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnShow>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<taskgroup>
<OnSuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<taskgroup>
<Property>
Type
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
abbreviation=
Task group abbreviation used for directory and naming purposes.
Type
System_String
Remarks
None.
Examples
None.
ACT XML Tags
Details
Mandatory
True
Name
abbreviation
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
<taskgroup>
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
category=
Category to which the task group applies.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
category
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
<taskgroup>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
headertext=
The text to display in the both the toolbox and the task group header block.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
headertext
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<taskgroup>
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
ACT XML Tags
TypeId
isparametricgroup=
Indicates whether the taskgroup operates only on parameters.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
isparametricgroup
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<taskgroup>
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
ACT XML Tags
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<taskgroups>
Class defining the task groups collection.
Remarks
None.
<tasks>
Examples
None.
Tag <TaskGroup> (p. 1025) No details

provided.
<TaskGroup>
Type
Ansys_ACT_Core_XmlDataModel_TaskGroup (p. 993)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_TaskGroup
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<tasks>
Class defining the tasks collection.
ACT XML Tags
Remarks
None.
Examples
None.
Tag <Task> (p. 1026) No details

provided.
<Task>
Type
Ansys_ACT_Core_XmlDataModel_Task (p. 946)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Task
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Templates>
<Templates>
Class defining a collection of control templates.
Remarks
None.
Examples
None.
Tag <ControlTemplate> (p. 1027) Defines a control template for the creation of groups of
properties.
<ControlTemplate>
Defines a control template for the creation of groups of properties.
Type
Ansys_ACT_Core_XmlDataModel_ControlTemplate (p. 103)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
ACT XML Tags
TypeId
<toolbar>
Class defining a toolbar in the UI of the application.
Remarks
None.
Examples
Example 1: The following example defines a toolbar with two entries.
<toolbar name="TestToolbar" caption="Test Toolbar">

<entry name="Entry 1" icon="icon1">
</entry>
<entry name="Entry 2" icon="icon2">
</entry>
</toolbar>
Tag <Separator> (p. 1028) Separator for the

toolbar.
Attribute caption= (p. 1029) Caption of the
toolbar.
Attribute name= (p. 1030) Name of the
toolbar.
<Separator>
Separator for the toolbar.
Type
Ansys_ACT_Core_XmlDataModel_Separator (p. 862)
Remarks
None.
Examples
None.
<toolbar>
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Separator
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Caption of the toolbar.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Name of the toolbar.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<udf>
Public
True
Description
None.
TypeId
<udf>
Specifies the UDF folder referenced by the extension.
Remarks
None.
Examples
None.
Attribute folder= (p. 1031) The path of the UDF

folder.
folder=
The path of the UDF folder.
Type
System_String
Remarks
The path referenced by this attribute is relative to the folder of the extension.
Examples
None.
Details
Name
folder
Mandatory
False
ACT XML Tags
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<UIDefinition>
Class defining a set of interface layouts that can be used for guided processes (wizards).
Remarks
None.
Examples
None.
Tag <ComponentDefinition> (p. 1032) No details

provided.
Tag <Layout> (p. 1033) No details
provided.
Type
Ansys_ACT_Core_XmlDataModel_UI_ComponentDefinition (p. 90)
<UIDefinition>
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Layout>
Type
Ansys_ACT_Core_XmlDataModel_UI_Layout (p. 311)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
ACT XML Tags
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<UserDefinedTask>
Class defining a new application task.
Remarks
None.
Examples
None.
Tag <Callbacks> (p. 1034) No details provided.

Callback <onUpdate> (p. 1035) No details provided.
BaseTaskTag)
BaseTaskTag)
<Callbacks>
Type
Remarks
None.
Examples
None.
<UserDefinedTask>
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<onUpdate>
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_string_
Name
onUpdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ACT XML Tags
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Description
None.
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
<UserDefinedTask>
MultipleValue
False
MappedValues
None.
Public
True
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
TypeId
<UserInputTask>
Class defining a new user input application task.
Remarks
None.
Examples
None.
Tag <DataModelInOut> (p. 1038) The panel associated to the task.

BaseTaskTag)
BaseTaskTag)
Attribute panel= (p. 1041) The panel associated to the task.
<DataModelInOut>
Type
Ansys_ACT_Core_XmlDataModel_Application_DataModelInOut (p. 106)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_DataModelInOut
<UserInputTask>
MinOccurence
1
MaxOccurence
-1
RealParent
None.
Mandatory
True
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Description
None.
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
ACT XML Tags
MappedValues
None.
Public
True
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
<UserInputTask>
TypeId
panel=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
panel
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
ACT XML Tags
<UserObject>
Class defining a user object of the data model.
Remarks
None.
Examples
None.

<UserObject>
Attribute basedonxmldefinition= (p. 1063) Indicates if the definition of the UserObject is
strictly defined by its xml definition.
Attribute cardinality= (p. 1065) Cardinality of the user object regarding is parent.
Attribute parent= (p. 1069) Name of the parent user object.
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
ACT XML Tags
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
<UserObject>
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanDuplicate>
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanRemove>
Type
<UserObject>
Remarks
None.
Examples
None.
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<IsValid>
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnAdd>
Type
<UserObject>
Remarks
Examples
None.
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
<UserObject>
Remarks
None.
Examples
None.
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnClearData>
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnDuplicate>
Type
<UserObject>
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnGenerateData>
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnHide>
Type
<UserObject>
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnInit>
Type
ACT XML Tags
Remarks
Examples
None.
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnMigrate>
Type
<UserObject>
Remarks
Examples
None.
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnReady>
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnRemove>
Type
<UserObject>
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnShow>
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnSuppress>
Type
<UserObject>
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnUnsuppress>
Type
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Property>
Type
<UserObject>
Remarks
None.
Examples
None.
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
basedonxmldefinition=
Indicates if the definition of the UserObject is strictly defined by its xml definition.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
basedonxmldefinition
ACT XML Tags
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
caption=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
<UserObject>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
cardinality=
Cardinality of the user object regarding is parent.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
cardinality
DefaultValue
0+
DataDefinition
False
AllowedValues
None.
MultipleValue
False
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
<UserObject>
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
ACT XML Tags
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<UserObject>
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
parent=
Name of the parent user object.
ACT XML Tags
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
parent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Remarks
None.
ACT XML Tags
Examples
None.
Tag <Callbacks> (p. 1072) No details

provided.
Callback <OnReadInput> (p. 1073) No details
provided.
Callback <OnSendBackData> (p. 1074) No details
provided.
Callback <OnSendData> (p. 1075) No details
provided.
Callback <OnWriteInput> (p. 1076) No details
provided.
Attribute userObject= (p. 1077) No details
provided.
<Callbacks>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<OnReadInput>
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__StreamReader_
Name
OnReadInput
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
ACT XML Tags
TypeId
<OnSendBackData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__IExtAPI_
Name
OnSendBackData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnSendData>
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__IExtAPI_
Name
OnSendData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
ACT XML Tags
<OnWriteInput>
Type
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__StreamWriter_
Name
OnWriteInput
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Wizard>
userObject=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
userObject
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Wizard>
Class defining a guided process (a wizard or AIM custom template) within the extension.
ACT XML Tags
Remarks
None.
Examples
None.
IronPython extension script. (inherited from BaseApplication)
Callback <canstart> (p. 1079) Callback that is invoked to determine whether the application
can be started. (inherited from BaseApplication)
Tag <Description> (p. 1080) Description of the application. (inherited from BaseApplication)
Tag <Step> (p. 1081) No details provided.
Attribute allowNavigation= (p. 1081) No details provided.
Attribute caption= (p. 1082) Caption of the application. (inherited from BaseApplication)
Attribute context= (p. 1083) Context or combination of contexts (separated using '|').
(inherited from BaseApplication)
Attribute hidden= (p. 1084) No details provided.
Attribute icon= (p. 1085) Icon for the application. (inherited from BaseApplication)
Attribute layout= (p. 1086) Layout to be used to display the wizard.
Attribute name= (p. 1087) Name of the application. (inherited from BaseApplication)
Attribute persistent= (p. 1088) No details provided.
Attribute subContext= (p. 1088) Sub-context used by AIM to filter the availability of the wizard.
Attribute version= (p. 1089) Major version of the application. (inherited from BaseApplication)
<Callbacks>
BaseApplication)
Type
Remarks
None.
Examples
None.
<Wizard>
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<canstart>
Callback that is invoked to determine whether the application can be started. (inherited from Base-
Application)
Type
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_string__bool_
Name
canstart
Public
True
Obsolete
False
ObsoleteMessage
None.
ACT XML Tags
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Description>
Description of the application. (inherited from BaseApplication)
Type
System_String
Remarks
None.
Examples
None.
Details
Description
Description of the wizard.
ValueName
description
Name
Description
Public
True
TypeId
<Wizard>
<Step>
Type
Ansys_ACT_Core_XmlDataModel_Step (p. 907)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Step
MinOccurence
1
MaxOccurence
-1
RealParent
None.
Mandatory
True
TypeId
allowNavigation=
Type
System_Boolean
Remarks
None.
Examples
None.
ACT XML Tags
Details
Name
allowNavigation
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
caption=
Caption of the application. (inherited from BaseApplication)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
caption
<Wizard>
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
context=
Context or combination of contexts (separated using '|'). (inherited from BaseApplication)
Type
Remarks
Examples
None.
Details
Name
context
Mandatory
True
DefaultValue
None.
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
hidden=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
hidden
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
<Wizard>
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
icon=
Icon for the application. (inherited from BaseApplication)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
icon
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
ACT XML Tags
Public
True
Description
None.
TypeId
layout=
Layout to be used to display the wizard.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
layout
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
<Wizard>
TypeId
name=
Name of the application. (inherited from BaseApplication)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
ACT XML Tags
persistent=
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
persistent
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
subContext=
Sub-context used by AIM to filter the availability of the wizard.
<Wizard>
Type
System_String
Remarks
None.
Examples
None.
Details
Name
subContext
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Major version of the application. (inherited from BaseApplication)
Type
System_Int32
ACT XML Tags
Remarks
None.
Examples
None.
Details
Name
version
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
<Workflow>
Class defining the top-level workflow tag within an ACT app.
Remarks
Used to define process integration items (tasks and task groups)
<Workflow>
Examples
None.

Callback <onafterdesignpointchanged> (p. 1099) Callback that is invoked after the design point has
changed.
Callback <onaftertaskcanduplicate> (p. 1101) Callback that is invoked after a task determines
duplication viability.
Callback <onaftertaskcanusetransfer> (p. 1102) Callback that is invoked after a task determines
transfer data viability.
Callback <onaftertaskcreation> (p. 1103) Callback that is invoked after a task has been
created.
Callback <onaftertaskdeletion> (p. 1104) Callback that is invoked after a task is deleted.
Callback <onaftertaskduplicate> (p. 1105) Callback that is invoked after a task has been
duplicated.
Callback <onaftertaskpropertyretrieval> (p. 1106) CCallback that is invoked after a task provides its
property-containing objects.
Callback <onaftertaskrefresh> (p. 1107) Callback that is invoked after a task has been
refreshed.
Callback <onaftertaskreset> (p. 1108) Callback that is invoked after a task has been reset.
Callback <onaftertasksourceschanged> (p. 1109) Callback that is invoked after a task handles a
source change.
Callback <onaftertaskstatus> (p. 1110) Callback that is invoked after a task determines
its status.
Callback <onaftertaskupdate> (p. 1111) Callback that is invoked after a task has been
updated.
Callback <onbeforedesignpointchanged> (p. 1112)Callback that is invoked immediately before the
design point changes.
Callback <onbeforetaskcanduplicate> (p. 1113) Callback that is invoked before a task determines
duplication viability.
ACT XML Tags
Callback <onbeforetaskcanusetransfer> (p. 1114) Callback that is invoked before a task determines
transfer data viability.
Callback <onbeforetaskcreation> (p. 1115) Callback that is invoked before a task is created.
Callback <onbeforetaskdeletion> (p. 1116) Callback that is invoked before a task is deleted.
Callback <onbeforetaskduplicate> (p. 1117) Callback that is invoked before a task is duplicated.
Callback <onbeforetaskpropertyretrieval> (p. 1118)Callback that is invoked before a task provides its
property-containing objects.
Callback <onbeforetaskrefresh> (p. 1119) Callback that is invoked before a task is refreshed.
Callback <onbeforetaskreset> (p. 1120) Callback that is invoked before a task is reset.
Callback <onbeforetasksourceschanged> (p. 1121)Callback that is invoked before a task handles a
source change.
Callback <onbeforetaskstatus> (p. 1122) Callback that is invoked before a task determines
its status.
Callback <onbeforetaskupdate> (p. 1123) Callback that is invoked before a task is updated.
Tag <TaskGroups> (p. 1137) Task groupings to be exposed as organized blocks
within the workflow.
Tag <Tasks> (p. 1138) Tasks xposed by this workflow.
<Workflow>
Attribute context= (p. 1140) Contexts (application) to which this workflow
applies.
<Attributes>
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<Callbacks>
ACT XML Tags
Type
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<CanAdd>
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanDuplicate>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<CanRemove>
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<IsValid>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnAdd>
Type
Remarks
Examples
None.
<Workflow>
Details
CallbackType
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onafterdesignpointchanged>
Callback that is invoked after the design point has changed.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
onafterdesignpointchanged
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskcanduplicate>
Callback that is invoked after a task determines duplication viability.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 517)
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
FuncCallback_object__object_
Name
onaftertaskcanduplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskcanusetransfer>
Callback that is invoked after a task determines transfer data viability.
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
FuncCallback_IUserObject__IUserObject__object__object_
Name
onaftertaskcanusetransfer
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskcreation>
Callback that is invoked after a task has been created.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
onaftertaskcreation
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskdeletion>
Callback that is invoked after a task is deleted.
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
Name
onaftertaskdeletion
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskduplicate>
Callback that is invoked after a task has been duplicated.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
onaftertaskduplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskpropertyretrieval>
CCallback that is invoked after a task provides its property-containing objects.
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
FuncCallback_IUserObject__object__object_
Name
onaftertaskpropertyretrieval
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskrefresh>
Callback that is invoked after a task has been refreshed.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
onaftertaskrefresh
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskreset>
Callback that is invoked after a task has been reset.
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
Name
onaftertaskreset
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertasksourceschanged>
Callback that is invoked after a task handles a source change.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
onaftertasksourceschanged
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskstatus>
Callback that is invoked after a task determines its status.
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
FuncCallback_IUserObject__object__object_
Name
onaftertaskstatus
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onaftertaskupdate>
Callback that is invoked after a task has been updated.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
onaftertaskupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforedesignpointchanged>
Callback that is invoked immediately before the design point changes.
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
Name
onbeforedesignpointchanged
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskcanduplicate>
Callback that is invoked before a task determines duplication viability.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
onbeforetaskcanduplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskcanusetransfer>
Callback that is invoked before a task determines transfer data viability.
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
ActionCallback_IUserObject__IUserObject_
Name
onbeforetaskcanusetransfer
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskcreation>
Callback that is invoked before a task is created.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
onbeforetaskcreation
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskdeletion>
Callback that is invoked before a task is deleted.
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
Name
onbeforetaskdeletion
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskduplicate>
Callback that is invoked before a task is duplicated.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
onbeforetaskduplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskpropertyretrieval>
Callback that is invoked before a task provides its property-containing objects.
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
Name
onbeforetaskpropertyretrieval
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskrefresh>
Callback that is invoked before a task is refreshed.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
onbeforetaskrefresh
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskreset>
Callback that is invoked before a task is reset.
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
Name
onbeforetaskreset
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetasksourceschanged>
Callback that is invoked before a task handles a source change.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
onbeforetasksourceschanged
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskstatus>
Callback that is invoked before a task determines its status.
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
Name
onbeforetaskstatus
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<onbeforetaskupdate>
Callback that is invoked before a task is updated.
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
onbeforetaskupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
Name
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnClearData>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnDuplicate>
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnGenerateData>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnHide>
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnInit>
Type
Remarks
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnMigrate>
Type
Remarks
Examples
None.
<Workflow>
Details
CallbackType
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnReady>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnRemove>
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnShow>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnSuppress>
Type
Remarks
None.
Examples
None.
<Workflow>
Details
CallbackType
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<OnUnsuppress>
Type
Remarks
None.
Examples
None.
ACT XML Tags
Details
CallbackType
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
0
MaxOccurence
-1
RealParent
Mandatory
False
TypeId
<Property>
Type
Remarks
None.
Examples
None.
<Workflow>
Details
ChildType
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<TaskGroups>
Task groupings to be exposed as organized blocks within the workflow.
Type
Ansys_ACT_Core_XmlDataModel_TaskGroups (p. 1024)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_TaskGroups
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
ACT XML Tags
TypeId
<Tasks>
Tasks xposed by this workflow.
Type
Ansys_ACT_Core_XmlDataModel_Tasks (p. 1025)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Tasks
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
caption=
Type
System_String
Remarks
None.
<Workflow>
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
class=
Type
System_String
Remarks
ACT XML Tags
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
context=
Contexts (application) to which this workflow applies.
Type
Remarks
None.
Examples
None.
<Workflow>
Details
Name
context
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
contextual=
Type
System_Boolean
Remarks
Examples
None.
Details
Mandatory
False
ACT XML Tags
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
icon=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
<Workflow>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
name=
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
version=
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
<Workflow>
Public
True
Description
None.
TypeId
<Workflow>
Class defining a new application workflow.
Remarks
The name of the application will be a new context available for customization.
Examples
None.
Tag <ApplicationTaskLink> (p. 1145) Links connecting task in the

workflow.
Tag <UserDefinedTask> (p. 1146) Tasks used by the workflow.
<ApplicationTaskLink>
Links connecting task in the workflow.
Type
Ansys_ACT_Core_XmlDataModel_Application_ApplicationTaskLink (p. 319)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_ApplicationTaskLink
MinOccurence
0
ACT XML Tags
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
<UserDefinedTask>
Tasks used by the workflow.
Type
Ansys_ACT_Core_XmlDataModel_Application_UserDefinedTask (p. 1034)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_UserDefinedTask
MinOccurence
0
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId

ANSYS ACT XML Reference Guide

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

ANSYS ACT XML Reference Guide

Uploaded by

Copyright:

Available Formats

ACT XML Reference Guide

ANSYS, Inc. Release 2020 R1

© 2020 ANSYS, Inc. Unauthorized use, distribution or duplication is prohibited.

U.S. Government Rights

Published in the U.S.A.

<OnAfterGeometryUpdate> ................................................................................................... 128

<Wizard> ............................................................................................................................... 173

<CanRemove> ........................................................................................................................ 221

<inputfile> ................................................................................................................................... 267

<Component> ........................................................................................................................ 311

IsLoad= .................................................................................................................................. 358

<Attributes> ........................................................................................................................... 409

<Configuration> ..................................................................................................................... 460

minimumnumberofconstraints= ............................................................................................. 509

visible= .................................................................................................................................. 553

caption= ................................................................................................................................ 599

<Callbacks> ............................................................................................................................ 648

<OnApply> ............................................................................................................................ 698

<OnEndPost> ......................................................................................................................... 749

<OutputFile> .......................................................................................................................... 799

version= ................................................................................................................................. 849

contextual= ............................................................................................................................ 897

name= ................................................................................................................................... 945

<taskgroup> ................................................................................................................................ 993

caption= ............................................................................................................................... 1036

context= ............................................................................................................................... 1083

<OnUnsuppress> .................................................................................................................. 1135

51. XML Tag Listing ................................................................................................................................... 313

103. XML Tag Listing ................................................................................................................................ 1145

<action> (p. 6) No details provided.

<DataModelView> (p. 110) Class defining a panel to be displayed in the

<task> (p. 990) No details provided.

Table 2: XML Tag Listing

Tag <ConnectTo> (p. 6) No details

Table 3: XML Tag Listing

Table 4: XML Tag Listing

Tag <Action> (p. 14) No details

Table 5: XML Tag Listing

Tag <StandardAction> (p. 18) No details provided.

Table 6: XML Tag Listing

Tag <actions> (p. 21) No details provided.

Table 7: XML Tag Listing

Attribute name= (p. 40) The argument name.

<assembly src="CSharp.dll" namespace="CSharp" />

Table 8: XML Tag Listing

Table 9: XML Tag Listing

Attribute name= (p. 47) Name of the view. (inherited from

Table 10: XML Tag Listing

Table 11: XML Tag Listing

Attribute InvokeUIThread= (p. 51) Invoke this callback on UIThread or not.

Table 12: XML Tag Listing

Table 13: XML Tag Listing

Table 14: XML Tag Listing

Table 15: XML Tag Listing

Table 16: XML Tag Listing

Table 17: XML Tag Listing

Tag <Callback> (p. 67) No details

Table 18: XML Tag Listing

Table 19: XML Tag Listing

Attribute component= (p. 89) No details

Table 20: XML Tag Listing

Attribute Class= (p. 91) Class to control this component.

Table 21: XML Tag Listing