Professional Documents
Culture Documents
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.
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. iii
ACT XML Reference Guide
value= ...................................................................................................................................... 51
<assembly> .................................................................................................................................... 52
context= .................................................................................................................................. 52
namespace= ............................................................................................................................. 53
src= .......................................................................................................................................... 54
<attributes> ................................................................................................................................... 56
<BrowserView> .............................................................................................................................. 56
name= ..................................................................................................................................... 56
<Callback> ..................................................................................................................................... 57
caninterrupt= ........................................................................................................................... 58
iscsharpstatic= ......................................................................................................................... 59
<CallbackEvaluate> ........................................................................................................................ 60
caninterrupt= ........................................................................................................................... 60
InvokeUIThread= ...................................................................................................................... 61
iscsharpstatic= ......................................................................................................................... 63
<CallbackGetCommands> .............................................................................................................. 64
caninterrupt= ........................................................................................................................... 64
InvokeUIThread= ...................................................................................................................... 65
iscsharpstatic= ......................................................................................................................... 66
location= .................................................................................................................................. 67
order= ...................................................................................................................................... 68
<CallbackGetPostPreSolveCommands> .......................................................................................... 70
caninterrupt= ........................................................................................................................... 70
iscsharpstatic= ......................................................................................................................... 71
order= ...................................................................................................................................... 72
timedependent= ...................................................................................................................... 73
<CallbackOnActiveObjectChange> ................................................................................................. 74
caninterrupt= ........................................................................................................................... 75
iscsharpstatic= ......................................................................................................................... 76
name= ..................................................................................................................................... 77
type= ....................................................................................................................................... 78
<CallbackOnGenerate> .................................................................................................................. 79
caninterrupt= ........................................................................................................................... 80
InvokeUIThread= ...................................................................................................................... 81
iscsharpstatic= ......................................................................................................................... 82
<CallbackOnSolve> ........................................................................................................................ 83
caninterrupt= ........................................................................................................................... 83
InvokeUIThread= ...................................................................................................................... 84
iscsharpstatic= ......................................................................................................................... 85
<Callbacks> .................................................................................................................................... 86
<Callback> ............................................................................................................................... 87
<Component> ............................................................................................................................... 88
<Attributes> ............................................................................................................................. 89
BottomAttachment= ................................................................................................................ 89
BottomOffset= ......................................................................................................................... 91
ComponentType= .................................................................................................................... 92
CustomCSSFile= ....................................................................................................................... 93
CustomHTMLFile= .................................................................................................................... 94
CustomJSFile= .......................................................................................................................... 95
Height= .................................................................................................................................... 96
HeightType= ............................................................................................................................ 97
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
iv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference Guide
LeftAttachment= ...................................................................................................................... 98
LeftOffset= ............................................................................................................................... 99
MaxHeight= ........................................................................................................................... 100
MaxWidth= ............................................................................................................................ 101
MinHeight= ............................................................................................................................ 102
MinWidth= ............................................................................................................................. 103
name= ................................................................................................................................... 105
RightAttachment= .................................................................................................................. 106
RightOffset= ........................................................................................................................... 107
TopAttachment= .................................................................................................................... 108
TopOffset= ............................................................................................................................. 109
visible= .................................................................................................................................. 110
Width= ................................................................................................................................... 111
WidthType= ............................................................................................................................ 112
<ComponentData> ...................................................................................................................... 113
component= .......................................................................................................................... 113
<ComponentDefinition> .............................................................................................................. 115
Class= .................................................................................................................................... 115
CSSFile= ................................................................................................................................. 116
DataModelClass= .................................................................................................................... 117
Directory= .............................................................................................................................. 118
HTMLFile= .............................................................................................................................. 119
JSFile= .................................................................................................................................... 120
Name= ................................................................................................................................... 122
<ComponentStyle> ...................................................................................................................... 123
component= .......................................................................................................................... 123
filter= ..................................................................................................................................... 124
<connectTo> ................................................................................................................................ 125
action= ................................................................................................................................... 126
event= ................................................................................................................................... 127
<contextmenus> .......................................................................................................................... 128
<UIEntry> ............................................................................................................................... 128
<ControlTemplate> ...................................................................................................................... 129
<Property> ............................................................................................................................. 129
name= ................................................................................................................................... 130
version= ................................................................................................................................. 131
<datamodel> ............................................................................................................................... 132
name= ................................................................................................................................... 133
<DataModel> ............................................................................................................................... 134
<UserObject> ......................................................................................................................... 134
icon= ...................................................................................................................................... 135
name= ................................................................................................................................... 136
<DataModelView> ........................................................................................................................ 137
chartComponent= .................................................................................................................. 138
dataModel= ............................................................................................................................ 139
imageComponent= ................................................................................................................ 140
name= ................................................................................................................................... 141
presentation= ......................................................................................................................... 142
propertiesComponent= .......................................................................................................... 143
sceneComponent= ................................................................................................................. 144
tabularComponent= ............................................................................................................... 146
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. v
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
vi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. vii
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
viii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. ix
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
x of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xi
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xiii
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xiv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xv
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xvii
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xix
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xx of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxi
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxiii
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxiv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxv
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxvi of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxvii
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxviii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxix
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxx 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 ....................................................................................................................................... 11
4. XML Tag Listing ....................................................................................................................................... 18
5. XML Tag Listing ....................................................................................................................................... 22
6. XML Tag Listing ....................................................................................................................................... 25
7. XML Tag Listing ....................................................................................................................................... 48
8. XML Tag Listing ....................................................................................................................................... 52
9. XML Tag Listing ....................................................................................................................................... 56
10. XML Tag Listing ..................................................................................................................................... 58
11. XML Tag Listing ..................................................................................................................................... 60
12. XML Tag Listing ..................................................................................................................................... 64
13. XML Tag Listing ..................................................................................................................................... 70
14. XML Tag Listing ..................................................................................................................................... 75
15. XML Tag Listing ..................................................................................................................................... 79
16. XML Tag Listing ..................................................................................................................................... 83
17. XML Tag Listing ..................................................................................................................................... 87
18. XML Tag Listing ..................................................................................................................................... 88
19. XML Tag Listing ................................................................................................................................... 113
20. XML Tag Listing ................................................................................................................................... 115
21. XML Tag Listing ................................................................................................................................... 123
22. XML Tag Listing ................................................................................................................................... 125
23. XML Tag Listing ................................................................................................................................... 128
24. XML Tag Listing ................................................................................................................................... 129
25. XML Tag Listing ................................................................................................................................... 133
26. XML Tag Listing ................................................................................................................................... 134
27. XML Tag Listing ................................................................................................................................... 138
28. XML Tag Listing ................................................................................................................................... 148
29. XML Tag Listing ................................................................................................................................... 150
30. XML Tag Listing ................................................................................................................................... 189
31. XML Tag Listing ................................................................................................................................... 197
32. XML Tag Listing ................................................................................................................................... 206
33. XML Tag Listing ................................................................................................................................... 231
34. XML Tag Listing ................................................................................................................................... 271
35. XML Tag Listing ................................................................................................................................... 273
36. XML Tag Listing ................................................................................................................................... 276
37. XML Tag Listing ................................................................................................................................... 317
38. XML Tag Listing ................................................................................................................................... 318
39. XML Tag Listing ................................................................................................................................... 330
40. XML Tag Listing ................................................................................................................................... 334
41. XML Tag Listing ................................................................................................................................... 338
42. XML Tag Listing ................................................................................................................................... 341
43. XML Tag Listing ................................................................................................................................... 344
44. XML Tag Listing ................................................................................................................................... 348
45. XML Tag Listing ................................................................................................................................... 350
46. XML Tag Listing ................................................................................................................................... 351
47. XML Tag Listing ................................................................................................................................... 353
48. XML Tag Listing ................................................................................................................................... 354
49. XML Tag Listing ................................................................................................................................... 396
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxxi
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxxii of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference Guide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. xxxiii
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
xxxiv of ANSYS, Inc. and its subsidiaries and affiliates.
ACT XML Reference
ACT XML Tags
Table 1: XML Tag Listing
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 3
ACT XML Tags
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
4 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable> (p. 465) Class encapsulating a list of child properties under
one table.
<Object> (p. 517) Class defining an object.
<operator> (p. 572) No details provided.
<Optimizer> (p. 576) Class defining an optimizer.
<OrderableCallback> (p. 660) 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. 664) Class defining an output-level data connection
definition.
<outputfile> (p. 667) This class defines the OutputFile XML Tag.
<outputs> (p. 669) Class defining the outputs collection for a task.
<Panel> (p. 670) Class defining a panel to be displayed in the
application.
<PanelComponent> (p. 679) No details provided.
<parameter> (p. 706) Class defining a single parameter definition for a task.
<parameters> (p. 746) Class defining the collection of task parameters.
<platform> (p. 747) This class defines the Platform XML Tag.
<Presentations> (p. 749) No details provided.
<ProductDataModelConverter> (p. 752) No details provided.
<ProductTask> (p. 761) Class defining a new user input application task.
<program> (p. 765) This class defines the Program XML Tag.
<projectdata> (p. 767) No details provided.
<property> (p. 769) Class defining a property of any user object.
<propertygroup> (p. 817) Class defining a collection of properties.
<propertytable> (p. 868) Class encapsulating a list of child properties under
one table.
<Result> (p. 920) Class defining a result.
<rsmjob> (p. 975) This class defines an rsm job.
<Sampling> (p. 1021) Class defining a DesignXplorer Sampling.
<Scene> (p. 1077) No details provided.
<script> (p. 1087) Specifies the IronPython script referenced by the
extension.
<separator> (p. 1091) Class defining the separator for items in a toolbar.
<simdata> (p. 1091) Class defining a general section that stores all user
object definitions.
<Solver> (p. 1094) Class specifying a third-party solver to be used in the
simulation.
<StandardAction> (p. 1147) No details provided.
<Step> (p. 1150) Class defining a step in a guided process a (wizard or
AIM custom template).
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 5
ACT XML Tags
<Target> (p. 1199) Class defining the target location for the object.
<task> (p. 1203) Class defining a task that encapsulates a single
process or application.
<task> (p. 1259) No details provided.
<taskgroup> (p. 1263) Class defining a collection of tasks.
<taskgroups> (p. 1306) Class defining the task groups collection.
<tasks> (p. 1307) Class defining the tasks collection.
<Templates> (p. 1309) Class defining a collection of control templates.
<toolbar> (p. 1310) Class defining a toolbar in the UI of the application.
<udf> (p. 1314) Specifies the UDF folder referenced by the extension.
<UIDefinition> (p. 1316) Class defining a set of interface layouts that can be
used for guided processes (wizards).
<UserDefinedTask> (p. 1318) Class defining a new application task.
<UserInputTask> (p. 1322) Class defining a new user input application task.
<UserObject> (p. 1327) Class defining a user object of the data model.
<UserObjectConverter> (p. 1367) No details provided.
<Wizard> (p. 1375) Class defining a guided process (a wizard or AIM
custom template) within the extension.
<Workflow> (p. 1390) Class defining the top-level workflow tag within an
ACT app.
<Workflow> (p. 1458) Class defining a new application workflow.
<action>
No details provided.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
6 of ANSYS, Inc. and its subsidiaries and affiliates.
<action>
<ConnectTo>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Language_ConnectTo (p. 125)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Language_ConnectTo
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<InputValue>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Language_InputValue (p. 352)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 7
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Language_InputValue
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Name=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
8 of ANSYS, Inc. and its subsidiaries and affiliates.
<action>
Details
Mandatory
True
Description
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Type=
No details provided.
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 9
ACT XML Tags
Examples
None.
Details
Mandatory
True
Description
Name
Type
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<ActionCallback>
Class defining the action callback.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
10 of ANSYS, Inc. and its subsidiaries and affiliates.
<ActionCallback>
Examples
None.
Attribute caninterrupt= (p. 11) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)
Attribute caption= (p. 12) No details provided.
Attribute icon= (p. 13) No details provided.
Attribute iscsharpstatic= (p. 14) Indicates whether the callback is a C Sharp static method. (inherited
from CallbackBase)
Attribute localize= (p. 15) Indicates whether the caption and value string need to be localized
by the application.
Attribute name= (p. 16) 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
Name
caninterrupt
DefaultValue
False
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 11
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
12 of ANSYS, Inc. and its subsidiaries and affiliates.
<ActionCallback>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 13
ACT XML Tags
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
iscsharpstatic=
Indicates whether the callback is a C Sharp static method. (inherited from CallbackBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
14 of ANSYS, Inc. and its subsidiaries and affiliates.
<ActionCallback>
Name
iscsharpstatic
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application.
Type
System_Boolean
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 15
ACT XML Tags
Details
Mandatory
False
Name
localize
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the action callback.
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
16 of ANSYS, Inc. and its subsidiaries and affiliates.
<actions>
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<actions>
No details provided.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 17
ACT XML Tags
Examples
None.
<Action>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Language_Action (p. 6)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Language_Action
MinOccurence
MaxOccurence
-1
RealParent
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
18 of ANSYS, Inc. and its subsidiaries and affiliates.
<actions>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Operator>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Language_Operator (p. 572)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Language_Operator
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 19
ACT XML Tags
MainAction=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
MainAction
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
20 of ANSYS, Inc. and its subsidiaries and affiliates.
<actions>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Name=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 21
ACT XML Tags
Description
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<ActionsView>
Class defining a panel to be displayed in the application.
Remarks
None.
Examples
None.
<StandardAction>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Application_StandardAction (p. 1147)
Remarks
None.
Examples
None.
Details
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
22 of ANSYS, Inc. and its subsidiaries and affiliates.
<ActionsView>
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
component=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
component
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 23
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the view. (inherited from View)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
name
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
24 of ANSYS, Inc. and its subsidiaries and affiliates.
<Application>
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Application>
Class defining a new application.
Remarks
The name of the application will be a new context available for customization.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 25
ACT XML Tags
<actions>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Language_Workflow (p. 17)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
26 of ANSYS, Inc. and its subsidiaries and affiliates.
<Application>
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<ApplicationWorkflow>
Defines the workflow to be used by the application.
Type
Ansys_ACT_Core_XmlDataModel_Application_ApplicationWorkflow (p. 1458)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 27
ACT XML Tags
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script. (inherited from
BaseApplication)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
28 of ANSYS, Inc. and its subsidiaries and affiliates.
<Application>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<canstart>
Callback that is invoked to determine whether the application can be started. (inherited from Base-
Application)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_string__bool_
Name
canstart
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 29
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<DataModel>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Application_DataModel (p. 134)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_DataModel
MinOccurence
MaxOccurence
-1
RealParent
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
30 of ANSYS, Inc. and its subsidiaries and affiliates.
<Application>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Description>
Description of the application. (inherited from BaseApplication)
Type
System_String
Remarks
None.
Examples
None.
Details
Description
ValueName
description
Name
Description
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute
<OnApplicationFinished>
Callback that is invoked after the application finishes.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 31
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_Application_
Name
OnApplicationFinished
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
32 of ANSYS, Inc. and its subsidiaries and affiliates.
<Application>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnApplicationStarted>
Callback that is invoked when the application starts.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_Application_
Name
OnApplicationStarted
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 33
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBeforeProjectClosed>
Callback that is invoked before a project is closed.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_Application_
Name
OnBeforeProjectClosed
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
34 of ANSYS, Inc. and its subsidiaries and affiliates.
<Application>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBeforeSave>
Callback that is invoked before a project is saved.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_Application_
Name
OnBeforeSave
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 35
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnProjectLoaded>
Callback that is invoked when a project is loaded or a new project started.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_Application_
Name
OnProjectLoaded
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
36 of ANSYS, Inc. and its subsidiaries and affiliates.
<Application>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Panel>
Defines one or more panels to be displayed in the application.
Type
Ansys_ACT_Core_XmlDataModel_Application_Panel (p. 670)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 37
ACT XML Tags
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Presentations>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Application_Presentations (p. 749)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
38 of ANSYS, Inc. and its subsidiaries and affiliates.
<Application>
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<ProductDataModelConverter>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Application_ProductDataModelConverter (p. 752)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 39
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
caption=
Caption of the application. (inherited from BaseApplication)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
40 of ANSYS, Inc. and its subsidiaries and affiliates.
<Application>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 41
ACT XML Tags
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Mandatory
True
Name
context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
42 of ANSYS, Inc. and its subsidiaries and affiliates.
<Application>
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the application. (inherited from BaseApplication)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 43
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the application. (inherited from BaseApplication)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
44 of ANSYS, Inc. and its subsidiaries and affiliates.
<Application>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
projectExtName=
Project extension name for associated project files.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
projectExtName
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 45
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Major version of the application. (inherited from BaseApplication)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
version
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
46 of ANSYS, Inc. and its subsidiaries and affiliates.
<Application>
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
WorkflowToStart=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 47
ACT XML Tags
Name
WorkflowToStart
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<argument>
This class defines the Argument XML Tag.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
48 of ANSYS, Inc. and its subsidiaries and affiliates.
<argument>
name=
The argument name.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 49
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
separator=
The argument-value separator.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
separator
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
50 of ANSYS, Inc. and its subsidiaries and affiliates.
<argument>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
value=
The argument value.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
value
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 51
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<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:
Attribute context= (p. 52) Context or combination of contexts (separated using '|') for the
import.
Attribute namespace= (p. 53) Namespace to import.
Attribute src= (p. 54) 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).
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
52 of ANSYS, Inc. and its subsidiaries and affiliates.
<assembly>
Examples
None.
Details
Mandatory
False
Name
context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
namespace=
Namespace to import.
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 53
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
namespace
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
src=
Name of the dll file to import.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
54 of ANSYS, Inc. and its subsidiaries and affiliates.
<assembly>
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 55
ACT XML Tags
<attributes>
Class defining the set of attributes for the object.
Remarks
None.
Examples
None.
<BrowserView>
Class defining a panel to be displayed in the application.
Remarks
None.
Examples
None.
name=
Name of the view. (inherited from View)
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
56 of ANSYS, Inc. and its subsidiaries and affiliates.
<Callback>
Details
Mandatory
True
Description
None.
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Callback>
No details provided.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 57
ACT XML Tags
Examples
None.
Attribute caninterrupt= (p. 58) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)
Attribute iscsharpstatic= (p. 59) Indicates whether the callback is a C Sharp static method. (inherited
from CallbackBase)
caninterrupt=
Specifies whether the callback can be cancelled/interrupted. (inherited from CallbackBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caninterrupt
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
58 of ANSYS, Inc. and its subsidiaries and affiliates.
<Callback>
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
iscsharpstatic=
Indicates whether the callback is a C Sharp static method. (inherited from CallbackBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
iscsharpstatic
DefaultValue
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 59
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<CallbackEvaluate>
No details provided.
Remarks
None.
Examples
None.
Attribute caninterrupt= (p. 60) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)
Attribute InvokeUIThread= (p. 61) Invoke this callback on UIThread or not.
Attribute iscsharpstatic= (p. 63) Indicates whether the callback is a C Sharp static method.
(inherited from CallbackBase)
caninterrupt=
Specifies whether the callback can be cancelled/interrupted. (inherited from CallbackBase)
Type
System_Boolean
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
60 of ANSYS, Inc. and its subsidiaries and affiliates.
<CallbackEvaluate>
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caninterrupt
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
InvokeUIThread=
Invoke this callback on UIThread or not.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 61
ACT XML Tags
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
62 of ANSYS, Inc. and its subsidiaries and affiliates.
<CallbackEvaluate>
iscsharpstatic=
Indicates whether the callback is a C Sharp static method. (inherited from CallbackBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
iscsharpstatic
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 63
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<CallbackGetCommands>
Class providing the commands to add to the solver input file.
Remarks
Use the location attribute to specifiy the execution of the callback. Options include: -init -pre -post -
solve -preload
Examples
None.
Attribute caninterrupt= (p. 64) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)
Attribute InvokeUIThread= (p. 65) Invoke this callback on UIThread or not.
Attribute iscsharpstatic= (p. 66) Indicates whether the callback is a C Sharp static method.
(inherited from CallbackBase)
Attribute location= (p. 67) Location of the call.
Attribute order= (p. 68) Order of the call.
caninterrupt=
Specifies whether the callback can be cancelled/interrupted. (inherited from CallbackBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
64 of ANSYS, Inc. and its subsidiaries and affiliates.
<CallbackGetCommands>
Name
caninterrupt
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
InvokeUIThread=
Invoke this callback on UIThread or not.
Type
System_Boolean
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 65
ACT XML Tags
Details
Mandatory
False
Name
InvokeUIThread
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
iscsharpstatic=
Indicates whether the callback is a C Sharp static method. (inherited from CallbackBase)
Type
System_Boolean
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
66 of ANSYS, Inc. and its subsidiaries and affiliates.
<CallbackGetCommands>
Examples
None.
Details
Mandatory
False
Name
iscsharpstatic
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
location=
Location of the call.
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 67
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
location
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
order=
Order of the call.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
68 of ANSYS, Inc. and its subsidiaries and affiliates.
<CallbackGetCommands>
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 69
ACT XML Tags
<CallbackGetPostPreSolveCommands>
Class collecting all commands to add to the solver input file.
Remarks
None.
Examples
None.
Attribute caninterrupt= (p. 70) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)
Attribute iscsharpstatic= (p. 71) Indicates whether the callback is a C Sharp static method.
(inherited from CallbackBase)
Attribute order= (p. 72) Order of the call.
Attribute timedependent= (p. 73) Specifies if the callback will be called for each step.
caninterrupt=
Specifies whether the callback can be cancelled/interrupted. (inherited from CallbackBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caninterrupt
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
70 of ANSYS, Inc. and its subsidiaries and affiliates.
<CallbackGetPostPreSolveCommands>
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
iscsharpstatic=
Indicates whether the callback is a C Sharp static method. (inherited from CallbackBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 71
ACT XML Tags
Name
iscsharpstatic
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
order=
Order of the call.
Type
System_Int32
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
72 of ANSYS, Inc. and its subsidiaries and affiliates.
<CallbackGetPostPreSolveCommands>
Details
Mandatory
False
Name
order
DefaultValue
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
timedependent=
Specifies if the callback will be called for each step.
Type
System_Boolean
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 73
ACT XML Tags
Examples
None.
Details
Mandatory
False
Name
timedependent
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<CallbackOnActiveObjectChange>
Callback that is invoked when the active object changes.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
74 of ANSYS, Inc. and its subsidiaries and affiliates.
<CallbackOnActiveObjectChange>
Examples
None.
Attribute caninterrupt= (p. 75) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)
Attribute iscsharpstatic= (p. 76) Indicates whether the callback is a C Sharp static method. (inherited
from CallbackBase)
Attribute name= (p. 77) The name filter.
Attribute type= (p. 78) The type filter.
caninterrupt=
Specifies whether the callback can be cancelled/interrupted. (inherited from CallbackBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
caninterrupt
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 75
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
iscsharpstatic=
Indicates whether the callback is a C Sharp static method. (inherited from CallbackBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
iscsharpstatic
Mandatory
False
DefaultValue
False
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
76 of ANSYS, Inc. and its subsidiaries and affiliates.
<CallbackOnActiveObjectChange>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
The name filter.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
Mandatory
False
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 77
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
type=
The type filter.
Type
Ansys_ACT_Interfaces_UserObject_ObjectTypeEnum
Remarks
None.
Examples
None.
Details
Name
type
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
78 of ANSYS, Inc. and its subsidiaries and affiliates.
<CallbackOnGenerate>
DefaultValue
Unknown
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<CallbackOnGenerate>
No details provided.
Remarks
None.
Examples
None.
Attribute caninterrupt= (p. 80) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)
Attribute InvokeUIThread= (p. 81) Invoke this callback on UIThread or not.
Attribute iscsharpstatic= (p. 82) Indicates whether the callback is a C Sharp static method.
(inherited from CallbackBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 79
ACT XML Tags
caninterrupt=
Specifies whether the callback can be cancelled/interrupted. (inherited from CallbackBase)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
80 of ANSYS, Inc. and its subsidiaries and affiliates.
<CallbackOnGenerate>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 81
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
iscsharpstatic=
Indicates whether the callback is a C Sharp static method. (inherited from CallbackBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
iscsharpstatic
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
82 of ANSYS, Inc. and its subsidiaries and affiliates.
<CallbackOnSolve>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<CallbackOnSolve>
No details provided.
Remarks
None.
Examples
None.
Attribute caninterrupt= (p. 83) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)
Attribute InvokeUIThread= (p. 84) Invoke this callback on UIThread or not.
Attribute iscsharpstatic= (p. 85) Indicates whether the callback is a C Sharp static method.
(inherited from CallbackBase)
caninterrupt=
Specifies whether the callback can be cancelled/interrupted. (inherited from CallbackBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 83
ACT XML Tags
Details
Mandatory
False
Name
caninterrupt
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
InvokeUIThread=
Invoke this callback on UIThread or not.
Type
System_Boolean
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
84 of ANSYS, Inc. and its subsidiaries and affiliates.
<CallbackOnSolve>
Examples
None.
Details
Mandatory
False
Name
InvokeUIThread
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
iscsharpstatic=
Indicates whether the callback is a C Sharp static method. (inherited from CallbackBase)
Type
System_Boolean
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 85
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
iscsharpstatic
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Callbacks>
Class specifying the callbacks that will invoke functions from the IronPython extension script.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
86 of ANSYS, Inc. and its subsidiaries and affiliates.
<Callbacks>
Remarks
The <callbacks> element and its children specify the Python functions that are invoked based on system-
and user-generated events.
Examples
None.
<Callback>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Callback
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 87
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Component>
Class defining a new component in a layout.
Remarks
None.
Examples
None.
Tag <Attributes> (p. 89) Defines the set of attributes for the
component.
Attribute BottomAttachment= (p. 89) Bottom attachment of the layout.
Attribute BottomOffset= (p. 91) Bottom offset related to the bottom
attachment.
Attribute ComponentType= (p. 92) Type of the component for the component.
Attribute CustomCSSFile= (p. 93) Custom css file for the component layout.
Attribute CustomHTMLFile= (p. 94) Custom html file for the component layout.
Attribute CustomJSFile= (p. 95) Custom jscript file for the component
layout.
Attribute Height= (p. 96) Height value for the component.
Attribute HeightType= (p. 97) Height type for the component.
Attribute LeftAttachment= (p. 98) Left attachment of the layout.
Attribute LeftOffset= (p. 99) Left offset related to the left attachment.
Attribute MaxHeight= (p. 100) Maximum height for the component.
Attribute MaxWidth= (p. 101) Maximum width for the component.
Attribute MinHeight= (p. 102) Minimum height for the component.
Attribute MinWidth= (p. 103) Minimum width for the component.
Attribute name= (p. 105) Name of the component.
Attribute RightAttachment= (p. 106) Right attachment of the layout.
Attribute RightOffset= (p. 107) Right offset related to the right
attachment.
Attribute TopAttachment= (p. 108) Top attachment of the layout.
Attribute TopOffset= (p. 109) Top offset related to the top attachment.
Attribute visible= (p. 110) Initial visibility of the component.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
88 of ANSYS, Inc. and its subsidiaries and affiliates.
<Component>
<Attributes>
Defines the set of attributes for the component.
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
BottomAttachment=
Bottom attachment of the layout.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 89
ACT XML Tags
Type
System_String
Remarks
The value can be the name of a component or "" for the border.
Examples
None.
Details
Mandatory
False
Name
BottomAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
90 of ANSYS, Inc. and its subsidiaries and affiliates.
<Component>
BottomOffset=
Bottom offset related to the bottom attachment.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
BottomOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 91
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ComponentType=
Type of the component for the component.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
ComponentType
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
92 of ANSYS, Inc. and its subsidiaries and affiliates.
<Component>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Mandatory
False
Name
CustomCSSFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 93
ACT XML Tags
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
CustomHTMLFile=
Custom html 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
Mandatory
False
Name
CustomHTMLFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
94 of ANSYS, Inc. and its subsidiaries and affiliates.
<Component>
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
CustomJSFile=
Custom jscript 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
Mandatory
False
Name
CustomJSFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 95
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Height=
Height value for the component.
Type
System_Single
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
Height
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
96 of ANSYS, Inc. and its subsidiaries and affiliates.
<Component>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
HeightType=
Height type for the component.
Type
Ansys_ACT_Interfaces_UserInterface_ComponentLengthType
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
HeightType
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 97
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LeftAttachment=
Left attachment of the layout.
Type
System_String
Remarks
The value can be the name of a component or "" for the border.
Examples
None.
Details
Mandatory
False
Name
LeftAttachment
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
98 of ANSYS, Inc. and its subsidiaries and affiliates.
<Component>
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LeftOffset=
Left offset related to the left attachment.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 99
ACT XML Tags
Name
LeftOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
MaxHeight=
Maximum height for the component.
Type
System_Int32
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
100 of ANSYS, Inc. and its subsidiaries and affiliates.
<Component>
Details
Mandatory
False
Name
MaxHeight
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
MaxWidth=
Maximum width for the component.
Type
System_Int32
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 101
ACT XML Tags
Examples
None.
Details
Mandatory
False
Name
MaxWidth
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
MinHeight=
Minimum height for the component.
Type
System_Int32
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
102 of ANSYS, Inc. and its subsidiaries and affiliates.
<Component>
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
MinHeight
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
MinWidth=
Minimum width for the component.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 103
ACT XML Tags
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
MinWidth
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
104 of ANSYS, Inc. and its subsidiaries and affiliates.
<Component>
name=
Name of the 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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 105
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
RightAttachment=
Right attachment of the layout.
Type
System_String
Remarks
The value can be the name of a component or "" for the border.
Examples
None.
Details
Mandatory
False
Name
RightAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
106 of ANSYS, Inc. and its subsidiaries and affiliates.
<Component>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
RightOffset=
Right offset related to the right attachment.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
RightOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 107
ACT XML Tags
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
TopAttachment=
Top attachment of the layout.
Type
System_String
Remarks
The value can be the name of a component or "" for the border.
Examples
None.
Details
Mandatory
False
Name
TopAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
108 of ANSYS, Inc. and its subsidiaries and affiliates.
<Component>
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
TopOffset=
Top offset related to the top attachment.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
TopOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 109
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
visible=
Initial visibility of the component.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
visible
DefaultValue
True
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
110 of ANSYS, Inc. and its subsidiaries and affiliates.
<Component>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Width=
Width value for the component.
Type
System_Single
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
Width
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 111
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
WidthType=
Width type for the component.
Type
Ansys_ACT_Interfaces_UserInterface_ComponentLengthType
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
WidthType
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
112 of ANSYS, Inc. and its subsidiaries and affiliates.
<ComponentData>
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<ComponentData>
Class defining the data for the component.
Remarks
None.
Examples
None.
component=
No details provided.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 113
ACT XML Tags
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
114 of ANSYS, Inc. and its subsidiaries and affiliates.
<ComponentDefinition>
<ComponentDefinition>
Class defining the display of the component.
Remarks
None.
Examples
None.
Class=
Class to control this component.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
Class
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 115
ACT XML Tags
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
CSSFile=
Default CSS file to use for this component.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
116 of ANSYS, Inc. and its subsidiaries and affiliates.
<ComponentDefinition>
Name
CSSFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
DataModelClass=
Class type that describes the data model of the component
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 117
ACT XML Tags
Details
Mandatory
False
Name
DataModelClass
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
118 of ANSYS, Inc. and its subsidiaries and affiliates.
<ComponentDefinition>
Examples
None.
Details
Mandatory
False
Name
Directory
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
HTMLFile=
Default HTML file to use for this component.
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 119
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
HTMLFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
JSFile=
Default JS file to use for this component.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
120 of ANSYS, Inc. and its subsidiaries and affiliates.
<ComponentDefinition>
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
JSFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 121
ACT XML Tags
Name=
Name of the component definition.
Type
System_String
Remarks
This will identify the component type.
Examples
None.
Details
Mandatory
True
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
122 of ANSYS, Inc. and its subsidiaries and affiliates.
<ComponentStyle>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<ComponentStyle>
Class defining the styles for the component.
Remarks
None.
Examples
None.
Attribute component= (p. 123) Name of the component for which styles are being
defined.
Attribute filter= (p. 124) Filter for the component styles.
component=
Name of the component for which styles are being defined.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
component
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 123
ACT XML Tags
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
filter=
Filter for the component styles.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
124 of ANSYS, Inc. and its subsidiaries and affiliates.
<connectTo>
Name
filter
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<connectTo>
No details provided.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 125
ACT XML Tags
action=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Name
action
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
126 of ANSYS, Inc. and its subsidiaries and affiliates.
<connectTo>
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
event=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Name
event
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 127
ACT XML Tags
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<contextmenus>
No details provided.
Remarks
None.
Examples
None.
<UIEntry>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_UIEntry (p. 197)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_UIEntry
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
128 of ANSYS, Inc. and its subsidiaries and affiliates.
<ControlTemplate>
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<ControlTemplate>
Class defining a control template for the creation of groups of properties.
Remarks
None.
Examples
None.
<Property>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 129
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
name=
Name of the control template.
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
130 of ANSYS, Inc. and its subsidiaries and affiliates.
<ControlTemplate>
Details
Mandatory
True
DefaultValue
None.
Name
name
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Version of the control template.
Type
System_Int32
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 131
ACT XML Tags
Examples
None.
Details
Name
version
Mandatory
False
DefaultValue
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<datamodel>
No details provided.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
132 of ANSYS, Inc. and its subsidiaries and affiliates.
<datamodel>
Examples
None.
name=
The name of the data model.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 133
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<DataModel>
Class defining a data model.
Remarks
None.
Examples
None.
<UserObject>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Application_UserObject (p. 1327)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
134 of ANSYS, Inc. and its subsidiaries and affiliates.
<DataModel>
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_UserObject
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
icon=
Icon of the data model.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 135
ACT XML Tags
Description
None.
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the data model.
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
136 of ANSYS, Inc. and its subsidiaries and affiliates.
<DataModelView>
Details
Mandatory
True
Description
None.
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<DataModelView>
Class defining a panel to be displayed in the application.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 137
ACT XML Tags
Examples
None.
chartComponent=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
chartComponent
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
138 of ANSYS, Inc. and its subsidiaries and affiliates.
<DataModelView>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
dataModel=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
dataModel
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 139
ACT XML Tags
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
imageComponent=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
140 of ANSYS, Inc. and its subsidiaries and affiliates.
<DataModelView>
Name
imageComponent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the view. (inherited from View)
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 141
ACT XML Tags
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
presentation=
No details provided.
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
142 of ANSYS, Inc. and its subsidiaries and affiliates.
<DataModelView>
Examples
None.
Details
Mandatory
False
Name
presentation
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
propertiesComponent=
No details provided.
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 143
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
propertiesComponent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
sceneComponent=
No details provided.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
144 of ANSYS, Inc. and its subsidiaries and affiliates.
<DataModelView>
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
sceneComponent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 145
ACT XML Tags
tabularComponent=
No details provided.
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
146 of ANSYS, Inc. and its subsidiaries and affiliates.
<DataModelView>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
treeComponent=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
treeComponent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 147
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<DialogProgressMonitorView>
No details provided.
Remarks
None.
Examples
None.
<task>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Application_ProgressMonitorTask (p. 1259)
Remarks
None.
Examples
None.
Details
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
148 of ANSYS, Inc. and its subsidiaries and affiliates.
<DialogProgressMonitorView>
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
name=
Name of the view. (inherited from View)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
name
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 149
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<entity>
Class defining a custom data entity definition based on an ACT XML Extension file.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
150 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
Callback <IsValid> (p. 158) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 159) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 160) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 162) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 163) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 164) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 165) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 166) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 167) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 168) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 170) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 171) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 172) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 173) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 174) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 175) No details provided. (inherited from SimEntity)
Attribute BeginGroup= (p. 176) Indicates whether the load object will have a
separator before it when shown in the context
menu. (inherited from SimEntity)
Attribute caption= (p. 177) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 178) Class name of the controller of the object.
(inherited from SimEntity)
Attribute ContextGroup= (p. 180) Indicates which group the load will be shown in
the context menu. (inherited from SimEntity)
Attribute contextual= (p. 181) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute datatype= (p. 182) Data type representing the schematic-exposed
type for which this data entity represents.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 151
ACT XML Tags
Attribute icon= (p. 183) Icon for the object. (inherited from SimEntity)
Attribute LazyActivateSelectProperties= (p. 184) Determines when onActivate callback is called for
the properties. (inherited from SimEntity)
Attribute localize= (p. 185) Indicates whether the caption and value string
need to be localized by the application. (inherited
from SimEntity)
Attribute name= (p. 186) Name of the object. (inherited from SimEntity)
Attribute version= (p. 187) Version of the object. (inherited from SimEntity)
<Attributes>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
152 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
<Callbacks>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 153
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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
154 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Name
CanCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 155
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
156 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Name
CanRemove
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 157
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
158 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is not invoked when the project is reopened.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 159
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
160 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 161
ACT XML Tags
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
162 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 163
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
164 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnGenerateData
Public
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 165
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
166 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 167
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
168 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 169
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
170 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 171
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnShow
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
172 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 173
ACT XML Tags
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
174 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 175
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
176 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
Examples
None.
Details
Name
BeginGroup
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the object. (inherited from SimEntity)
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 177
ACT XML Tags
Remarks
None.
Examples
None.
Details
Name
caption
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
class=
Class name of the controller of the object. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
178 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
Type
System_String
Remarks
The constructor of the class referenced by this attribute takes two arguments:
Examples
None.
Details
Name
class
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 179
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
ContextGroup
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
180 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Name
contextual
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 181
ACT XML Tags
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
datatype=
Data type representing the schematic-exposed type for which this data entity represents.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
datatype
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
182 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
icon
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 183
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
LazyActivateSelectProperties
Mandatory
False
DefaultValue
False
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
184 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
localize
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 185
ACT XML Tags
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
186 of ANSYS, Inc. and its subsidiaries and affiliates.
<entity>
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Version of the object. (inherited from SimEntity)
Type
System_Int32
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 187
ACT XML Tags
Details
Name
version
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<entry>
Class defining a drop-down menu within a toolbar.
Remarks
To create a drop-down menu inside a toolbar, an entry has to be created inside another entry.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
188 of ANSYS, Inc. and its subsidiaries and affiliates.
<entry>
Examples
None.
Tag <Callbacks> (p. 189) Specifies the callbacks that will invoke functions from the IronPython
extension script.
Tag <Entry> (p. 190) No details provided.
Callback <OnClick> (p. 191) Callback that is invoked to return when the object is clicked.
Attribute caption= (p. 192) Caption of the entry.
Attribute Icon= (p. 193) Icon of the entry.
Attribute localize= (p. 194) Indicates whether the caption and value string need to be localized
by the application.
Attribute name= (p. 195) Name of the entry.
Attribute userobject= (p. 196) Related user object name.
<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script.
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 189
ACT XML Tags
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Entry>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Entry (p. 188)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Entry
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
190 of ANSYS, Inc. and its subsidiaries and affiliates.
<entry>
<OnClick>
Callback that is invoked to return when the object is clicked.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IDataModelObject_
Name
OnClick
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 191
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
caption=
Caption of the entry.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
192 of ANSYS, Inc. and its subsidiaries and affiliates.
<entry>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Icon=
Icon of the entry.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
Icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 193
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
localize
DefaultValue
False
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
194 of ANSYS, Inc. and its subsidiaries and affiliates.
<entry>
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the entry.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
MultipleValue
False
Name
name
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 195
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
userobject=
Related user object name.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
userobject
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
196 of ANSYS, Inc. and its subsidiaries and affiliates.
<entry>
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<entry>
Class defining a user-interface GUI operatio.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 197
ACT XML Tags
<Callbacks>
Callbacks
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<onclick>
Callback that is invoked on click.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
198 of ANSYS, Inc. and its subsidiaries and affiliates.
<entry>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onclick
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 199
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
caption=
Display text of GUI operation.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
caption
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
200 of ANSYS, Inc. and its subsidiaries and affiliates.
<entry>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the object.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
icon
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 201
ACT XML Tags
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of GUI operation.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
202 of ANSYS, Inc. and its subsidiaries and affiliates.
<entry>
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
priority=
UI-level priority (for grouping and ordering purposes)
Type
System_Single
Remarks
None.
Examples
None.
Details
Name
priority
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 203
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
type=
Type of GUI operation.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
type
Mandatory
False
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
204 of ANSYS, Inc. and its subsidiaries and affiliates.
<entry>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Version of GUI operation...for backwards compatiblity
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
version
Mandatory
False
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 205
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<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. 207) Defines one or more ACT applications that will be posted to
the Ansys Store.
Tag <appStoreId> (p. 208) Defines a unique identifier for the ACT application, to be used
in the Ansys Store.
Tag <assembly> (p. 209) Defines one or more assemblies to be loaded.
Tag <author> (p. 210) Defines the author of the extension.
Tag <description> (p. 210) Defines the description of the extension.
Tag <Guid> (p. 211) Defines a unique identifier for the extension.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
206 of ANSYS, Inc. and its subsidiaries and affiliates.
<Extension>
<Application>
Defines one or more ACT applications that will be posted to the Ansys Store.
Type
Ansys_ACT_Core_XmlDataModel_Application_CustomApplication (p. 25)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 207
ACT XML Tags
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<appStoreId>
Defines a unique identifier for the ACT application, to be used in the Ansys Store.
Type
System_String
Remarks
None.
Examples
None.
Details
Description
Unique identifier of the application for the Ansys Store. The format must be: author_shortname.
ValueName
appStoreId
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
208 of ANSYS, Inc. and its subsidiaries and affiliates.
<Extension>
Name
appStoreId
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute
<assembly>
Defines one or more assemblies to be loaded.
Type
Ansys_ACT_Core_XmlDataModel_Assembly (p. 52)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 209
ACT XML Tags
<author>
Defines the author of the extension.
Type
System_String
Remarks
None.
Examples
None.
Details
Description
ValueName
authorName
Name
author
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute
<description>
Defines the description of the extension.
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
210 of ANSYS, Inc. and its subsidiaries and affiliates.
<Extension>
Examples
None.
Details
Description
ValueName
description
Name
description
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute
<Guid>
Defines a unique identifier for the extension.
Type
Ansys_ACT_Core_XmlDataModel_Guid (p. 316)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 211
ACT XML Tags
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<ImageDirectory>
Add a folder to find images.
Type
Ansys_ACT_Core_XmlDataModel_ImageDirectory (p. 330)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
212 of ANSYS, Inc. and its subsidiaries and affiliates.
<Extension>
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Interface>
Defines one or more the user interfaces for the extension.
Type
Ansys_ACT_Core_XmlDataModel_Interface (p. 354)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Licenses>
Defines a licenses collection for the extension.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 213
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Licenses (p. 406)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<script>
Specifies one or more IronPython scripts referenced by the extension.
Type
Ansys_ACT_Core_XmlDataModel_Script (p. 1087)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
214 of ANSYS, Inc. and its subsidiaries and affiliates.
<Extension>
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<simdata>
Defines one or more general sections that store all user object definitions.
Type
Ansys_ACT_Core_XmlDataModel_SimData (p. 1091)
Remarks
None.
Examples
None.
Details
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 215
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Templates>
Defines a collection of control templates for the extension.
Type
Ansys_ACT_Core_XmlDataModel_Templates (p. 1309)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
216 of ANSYS, Inc. and its subsidiaries and affiliates.
<Extension>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<UIDefinition>
Defines one or more user interfaces for the extension.
Type
Ansys_ACT_Core_XmlDataModel_UI_UIDefinition (p. 1316)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 217
ACT XML Tags
<Wizard>
Defines one or more wizards within the extension.
Type
Ansys_ACT_Core_XmlDataModel_Wizard (p. 1375)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Workflow>
Defines one or more user-defined custom workflows composed of tasks and task groups.
Type
Ansys_ACT_Core_XmlDataModel_Workflow (p. 1390)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
218 of ANSYS, Inc. and its subsidiaries and affiliates.
<Extension>
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
allowReload=
Specifies if the extension should be reloaded when reload button is clicked.
Type
System_Boolean
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 219
ACT XML Tags
Details
Mandatory
False
Name
allowReload
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
debug=
To start this extension in debug mode if in scripted mode.
Type
System_Boolean
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
220 of ANSYS, Inc. and its subsidiaries and affiliates.
<Extension>
Examples
None.
Details
Mandatory
False
Name
debug
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the extension.
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 221
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
isNative=
Specifies if the extension is native, in that case migration messages are ignored.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
222 of ANSYS, Inc. and its subsidiaries and affiliates.
<Extension>
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
isNative
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 223
ACT XML Tags
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.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
224 of ANSYS, Inc. and its subsidiaries and affiliates.
<Extension>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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.
Public
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 225
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
minorversion=
Minor version of the extension.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
minorversion
DefaultValue
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
226 of ANSYS, Inc. and its subsidiaries and affiliates.
<Extension>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 227
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
qaServices=
Specifies if the extension is covered under QA Services applicable by NQA-1
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
qaServices
DefaultValue
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
228 of ANSYS, Inc. and its subsidiaries and affiliates.
<Extension>
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 229
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Major version of the extension.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
version
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
230 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
DefaultValue
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<ExtensionObject>
Class extending the extension object definition. (Inherited from DesignXplorer SimEntity)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 231
ACT XML Tags
Callback <CanCreate> (p. 236) Callback that is invoked to determine whether the
object can be created via the Object Creation API.
(inherited from SimEntity)
Callback <CanDuplicate> (p. 237) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 238) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Callback <HostObjectModified> (p. 239) Callback that is invoked to return when the
properties of host object have changed.
Callback <IsValid> (p. 240) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 242) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 243) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 244) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 245) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 246) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 247) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 248) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 250) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 251) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 252) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 253) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 254) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 255) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 257) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 258) No details provided. (inherited from SimEntity)
Tag <Target> (p. 259) Defines the target location for the object.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
232 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
Attribute BeginGroup= (p. 259) Indicates whether the load object will have a
separator before it when shown in the context
menu. (inherited from SimEntity)
Attribute caption= (p. 260) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 262) Class name of the controller of the object.
(inherited from SimEntity)
Attribute ContextGroup= (p. 263) Indicates which group the load will be shown in
the context menu. (inherited from SimEntity)
Attribute contextual= (p. 264) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute icon= (p. 265) Icon for the object. (inherited from SimEntity)
Attribute LazyActivateSelectProperties= (p. 266) Determines when onActivate callback is called for
the properties. (inherited from SimEntity)
Attribute localize= (p. 267) Indicates whether the caption and value string
need to be localized by the application. (inherited
from SimEntity)
Attribute name= (p. 268) Name of the object. (inherited from SimEntity)
Attribute version= (p. 269) Version of the object. (inherited from SimEntity)
<Attributes>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 233
ACT XML Tags
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
234 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 235
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Name
CanCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
236 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 237
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Name
CanRemove
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
238 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<HostObjectModified>
Callback that is invoked to return when the properties of host object have changed.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 239
ACT XML Tags
Details
CallbackType
ActionCallback_IUserObject_
Name
HostObjectModified
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
240 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 241
ACT XML Tags
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
242 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 243
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
244 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnClearData
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 245
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
246 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 247
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
248 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 249
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
250 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 251
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Public
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
252 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 253
ACT XML Tags
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
254 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 255
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
256 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 257
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
258 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
<Target>
Defines the target location for the object.
Type
Ansys_ACT_Core_XmlDataModel_Target (p. 1199)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Type
System_Boolean
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 259
ACT XML Tags
Remarks
None.
Examples
None.
Details
Name
BeginGroup
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the object. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
260 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 261
ACT XML Tags
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:
Examples
None.
Details
Name
class
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
262 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
ContextGroup
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 263
ACT XML Tags
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Name
contextual
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
264 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
icon
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 265
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
LazyActivateSelectProperties
Mandatory
False
DefaultValue
False
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
266 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
localize
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 267
ACT XML Tags
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
268 of ANSYS, Inc. and its subsidiaries and affiliates.
<ExtensionObject>
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Version of the object. (inherited from SimEntity)
Type
System_Int32
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 269
ACT XML Tags
Details
Name
version
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<FileToolbarView>
Class defining a panel to be displayed in the application.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
270 of ANSYS, Inc. and its subsidiaries and affiliates.
<FileToolbarView>
Examples
None.
buttonsComponent=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Description
None.
Name
buttonsComponent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 271
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the view. (inherited from View)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
name
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
272 of ANSYS, Inc. and its subsidiaries and affiliates.
<filter>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<filter>
Class defining a filter for the object. The filtering mechanism itself is application specific.
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>
name=
Name of the filter.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 273
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
274 of ANSYS, Inc. and its subsidiaries and affiliates.
<filter>
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
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 275
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Geometry>
Class defining a geometry feature.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
276 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
Callback <OnGenerateData> (p. 294) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 295) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 296) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 298) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 299) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 300) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 301) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 302) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 303) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 305) No details provided. (inherited from SimEntity)
Attribute BeginGroup= (p. 305) Indicates whether the load object will have a
separator before it when shown in the context
menu. (inherited from SimEntity)
Attribute caption= (p. 307) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 308) Class name of the controller of the object.
(inherited from SimEntity)
Attribute ContextGroup= (p. 309) Indicates which group the load will be shown in
the context menu. (inherited from SimEntity)
Attribute contextual= (p. 310) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute icon= (p. 311) Icon for the object. (inherited from SimEntity)
Attribute LazyActivateSelectProperties= (p. 312) Determines when onActivate callback is called for
the properties. (inherited from SimEntity)
Attribute localize= (p. 313) Indicates whether the caption and value string
need to be localized by the application. (inherited
from SimEntity)
Attribute name= (p. 314) Name of the object. (inherited from SimEntity)
Attribute version= (p. 315) Version of the object. (inherited from SimEntity)
<Attributes>
No details provided. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 277
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
278 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 279
ACT XML Tags
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
280 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Name
CanCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 281
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
282 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 283
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
284 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 285
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGenerate>
Callback that is invoked at the end of the generation process.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
OnAfterGenerate
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
286 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 287
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
288 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 289
ACT XML Tags
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
290 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 291
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnEdit>
Callback that is invoked when the object is edited.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
OnEdit
Public
False
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
292 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerate>
Callback that is invoked when the object is generated.
Type
Ansys_ACT_Core_XmlDataModel_CallbackOnGenerate (p. 79)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnGenerate
Name
OnGenerate
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 293
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
294 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 295
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
296 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 297
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
298 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 299
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnRemove
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
300 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 301
ACT XML Tags
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
302 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 303
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
304 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 305
ACT XML Tags
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
BeginGroup
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
306 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
caption=
Caption of the object. (inherited from SimEntity)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 307
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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:
Examples
None.
Details
Name
class
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
308 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
ContextGroup
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 309
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Name
contextual
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
310 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
icon
Mandatory
False
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 311
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
LazyActivateSelectProperties
Mandatory
False
DefaultValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
312 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
localize
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 313
ACT XML Tags
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
314 of ANSYS, Inc. and its subsidiaries and affiliates.
<Geometry>
Details
Name
name
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Version of the object. (inherited from SimEntity)
Type
System_Int32
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 315
ACT XML Tags
Examples
None.
Details
Name
version
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<guid>
Class defining a unique identifier for the extension.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
316 of ANSYS, Inc. and its subsidiaries and affiliates.
<guid>
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()
shortid=
Short identifier for backward compatibility.
Type
System_String
Remarks
Must be the same as the extension name for all extensions created before R15.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 317
ACT XML Tags
Name
shortid
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Image>
No details provided.
Remarks
None.
Examples
None.
Tag <Callbacks> (p. 319) Specifies the callbacks that will invoke functions from the
IronPython extension script. (inherited from Presentation)
Callback <OnAdd> (p. 320) No details provided. (inherited from Presentation)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
318 of ANSYS, Inc. and its subsidiaries and affiliates.
<Image>
<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script. (inherited from
Presentation)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 319
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<OnAdd>
No details provided. (inherited from Presentation)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IPresentation_
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
320 of ANSYS, Inc. and its subsidiaries and affiliates.
<Image>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDelete>
No details provided. (inherited from Presentation)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IPresentation_
Name
OnDelete
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 321
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHighlight>
No details provided. (inherited from Presentation)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IPresentation_
Name
OnHighlight
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
322 of ANSYS, Inc. and its subsidiaries and affiliates.
<Image>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnhighlight>
No details provided. (inherited from Presentation)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IPresentation_
Name
OnUnhighlight
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 323
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUpdate>
No details provided. (inherited from Presentation)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
324 of ANSYS, Inc. and its subsidiaries and affiliates.
<Image>
Details
CallbackType
ActionCallback_IPresentation_
Name
OnUpdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
allowHighlight=
No details provided. (inherited from Presentation)
Type
System_Boolean
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 325
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
allowHighlight
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
FileNameProperty=
No details provided.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
326 of ANSYS, Inc. and its subsidiaries and affiliates.
<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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 327
ACT XML Tags
userObject=
No details provided. (inherited from Presentation)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
328 of ANSYS, Inc. and its subsidiaries and affiliates.
<Image>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
visibility=
No details provided. (inherited from Presentation)
Type
Ansys_ACT_Interfaces_Presentations_VisibilityOptions
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
visibility
DefaultValue
Always
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 329
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<ImageDirectory>
No details provided.
Remarks
None.
Examples
None.
<includegroup>
Class defining the include group tag (used by task groups).
Remarks
None.
Examples
None.
Attribute caption= (p. 330) The caption of the item to include. (inherited from IncludeTag)
Attribute external= (p. 331) Indicates whether the included item is defined outside of the extension
file. (inherited from IncludeTag)
Attribute name= (p. 333) Name of the item to include. (inherited from IncludeTag)
caption=
The caption of the item to include. (inherited from IncludeTag)
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
330 of ANSYS, Inc. and its subsidiaries and affiliates.
<includegroup>
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
external=
Indicates whether the included item is defined outside of the extension file. (inherited from IncludeTag)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 331
ACT XML Tags
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
external
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
332 of ANSYS, Inc. and its subsidiaries and affiliates.
<includegroup>
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 333
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<includetask>
Class defining the include task tag (used by task groups).
Remarks
None.
Examples
None.
Attribute caption= (p. 334) The caption of the item to include. (inherited from IncludeTag)
Attribute external= (p. 335) Indicates whether the included item is defined outside of the extension
file. (inherited from IncludeTag)
Attribute name= (p. 336) 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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
334 of ANSYS, Inc. and its subsidiaries and affiliates.
<includetask>
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 335
ACT XML Tags
Name
external
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the item to include. (inherited from IncludeTag)
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
336 of ANSYS, Inc. and its subsidiaries and affiliates.
<input>
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<input>
Class defining an input-level data connection definition.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 337
ACT XML Tags
Examples
None.
count=
Maximum number of simultaneous input instances.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
count
Mandatory
False
DefaultValue
-1
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
338 of ANSYS, Inc. and its subsidiaries and affiliates.
<input>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Name
format
Mandatory
False
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 339
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Name
type
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
340 of ANSYS, Inc. and its subsidiaries and affiliates.
<inputfile>
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<inputfile>
This class difines the InputFile XML Tag.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 341
ACT XML Tags
id=
The unique file id. (inherited from File)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
id
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
342 of ANSYS, Inc. and its subsidiaries and affiliates.
<inputfile>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
The file name. (inherited from File)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 343
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<inputFromActionOutput>
No details provided.
Remarks
None.
Examples
None.
action=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
344 of ANSYS, Inc. and its subsidiaries and affiliates.
<inputFromActionOutput>
Name
action
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
Name of action.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Name=
No details provided. (inherited from Input)
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 345
ACT XML Tags
Details
Mandatory
True
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
output=
No details provided.
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
346 of ANSYS, Inc. and its subsidiaries and affiliates.
<inputFromOperator>
Examples
None.
Details
Mandatory
True
Name
output
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<inputFromOperator>
No details provided.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 347
ACT XML Tags
Examples
None.
Name=
No details provided. (inherited from Input)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
348 of ANSYS, Inc. and its subsidiaries and affiliates.
<inputFromOperator>
MappedValues
None.
Public
True
Description
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
operator=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
operator
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 349
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<inputgroup>
Class defining the input group collections for a task.
Remarks
None.
Examples
None.
<Input>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Input (p. 337)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
350 of ANSYS, Inc. and its subsidiaries and affiliates.
<inputs>
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Input
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<inputs>
Class defining the inputs collection for a task.
Remarks
None.
Examples
None.
<InputGroup>
No details provided.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 351
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_InputGroup (p. 350)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_InputGroup
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<inputValue>
No details provided.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
352 of ANSYS, Inc. and its subsidiaries and affiliates.
<inputValue>
Examples
None.
Name=
No details provided. (inherited from Input)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 353
ACT XML Tags
MappedValues
None.
Public
True
Description
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Interface>
Class defining the user interface for the extension.
Remarks
This interface element information pertains specifically to the GUI.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
354 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
Callback <OnAfterSolve> (p. 369) Called when an analysis has been solved.
Callback <OnBeforeGeometryUpdate> (p. 370) OnBeforeGeometryUpdate.
Callback <OnBeforeSolve> (p. 372) Called when an analysis starts to solve.
Callback <OnBodySuppressStateChange> (p. 373) Called when the body suppress state change.
Callback <OnDraw> (p. 374) Called when the application is drawn.
Callback <OnDraw2D> (p. 375) Called when the application is drawn.
Callback <OnExternalModelImport> (p. 376) Called when an external model is imported.
Callback <OnInit> (p. 377) Called when the given context is initialized.
Callback <OnLoad> (p. 379) Called when a project is loaded - invoked from
non-Workbench products
Callback <OnMeshCleaned> (p. 380) Called when the mesh is cleaned.
Callback <OnMeshGenerated> (p. 381) Called when the mesh is generated.
Callback <OnPostFinished> (p. 382) Called when the post process end for a given
analysis.
Callback <OnPostStarted> (p. 383) Called when the post process start for a given
analysis.
Callback <OnReady> (p. 384) OnReady.
Callback <OnSave> (p. 385) Called when a project is saved - invoked from
non-Workbench products
Callback <OnTerminate> (p. 387) Called when the given context is terminated.
Callback <OnUnitsChanged> (p. 388) OnUnitsChanged. Called when the unit system
changes.
Callback <Resume> (p. 389) Called when a project is loaded. Usefull to retreive
aditional data.
Callback <Save> (p. 390) Called when a project is saved. Usefull to save
aditional data.
Tag <toolbar> (p. 391) Defines one or more toolbars.
Attribute context= (p. 392) Context or combination of contexts (separated
using '|') for the interface.
Attribute liteAPI= (p. 393) Specifies for what context or combinations of
contexts (separated using '|') liteAPI should be
invoked
Attribute propertyEvents= (p. 394) Specifies when property events should be invoked.
<Callbacks>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 355
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<filter>
Defines one or more filters.
Type
Ansys_ACT_Core_XmlDataModel_Filter (p. 273)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
356 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<GetLocalString>
Get the localized string.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetLocalString
Name
GetLocalString
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 357
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetPostCommands>
Called to collect all "post" commands to add to the solver input file.
Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 70)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
358 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetAnalysisSolveCommands
Name
GetPostCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetPreCommands>
Called to collect all "pre" commands to add to the solver input file.
Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 70)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 359
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetAnalysisSolveCommands
Name
GetPreCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
360 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
<GetSolveCommands>
Called to collect all "solve" commands to add to the solver input file.
Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 70)
Remarks
If timeDependent is true, the callback take as argument : analysis, step, stream
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetAnalysisSolveCommands
Name
GetSolveCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 361
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetToolTips>
Collect the GUI Entries ToolTips.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetToolTips
Name
GetToolTips
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
362 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<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
Name
images
ValueName
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 363
ACT XML Tags
<IsAnalysisValid>
Called to know if an analysis is valid.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsAnalysisValid
Name
IsAnalysisValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
364 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnActiveObjectChange>
Called when the active object change.
Type
Ansys_ACT_Core_XmlDataModel_CallbackOnActiveObjectChange (p. 74)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActiveObjectChanged
Name
OnActiveObjectChange
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 365
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
OnAfterGeometryUpdate.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
366 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterObjectChanged>
Called when an object has been changed.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAfterObjectChanged
Name
OnAfterObjectChanged
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 367
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterRemove>
OnAfterRemove.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
368 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
Name
OnAfterRemove
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterSolve>
Called when an analysis has been solved.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 369
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBeforeSolveAnalysis
Name
OnAfterSolve
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBeforeGeometryUpdate>
OnBeforeGeometryUpdate.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
370 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnBeforeGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 371
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBeforeSolve>
Called when an analysis starts to solve.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBeforeSolveAnalysis
Name
OnBeforeSolve
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
372 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Called when the body suppress state change.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 373
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDraw>
Called when the application is drawn.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDraw
Name
OnDraw
Public
False
Obsolete
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
374 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDraw2D>
Called when the application is drawn.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDraw
Name
OnDraw2D
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 375
ACT XML Tags
Public
False
Obsolete
True
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnExternalModelImport>
Called when an external model is imported.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
376 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnExternalModelImport
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Called when the given context is initialized.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 377
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInit
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
378 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
<OnLoad>
Called when a project is loaded - invoked from non-Workbench products
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnLoadSave
Name
OnLoad
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 379
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMeshCleaned>
Called when the mesh is cleaned.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnMeshCleaned
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
380 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMeshGenerated>
Called when the mesh is generated.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnMeshGenerated
Public
False
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 381
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnPostFinished>
Called when the post process end for a given analysis.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBeforeSolveAnalysis
Name
OnPostFinished
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
382 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnPostStarted>
Called when the post process start for a given analysis.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBeforeSolveAnalysis
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 383
ACT XML Tags
Name
OnPostStarted
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
OnReady.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
384 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSave>
Called when a project is saved - invoked from non-Workbench products
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 385
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnLoadSave
Name
OnSave
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
386 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnTerminate>
Called when the given context is terminated.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInit
Name
OnTerminate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 387
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnitsChanged>
OnUnitsChanged. Called when the unit system changes.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnUnitsChanged
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
388 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Resume>
Called when a project is loaded. Usefull to retreive aditional data.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ResumeExt
Name
Resume
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 389
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Save>
Called when a project is saved. Usefull to save aditional data.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_SaveExt
Name
Save
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
390 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<toolbar>
Defines one or more toolbars.
Type
Ansys_ACT_Core_XmlDataModel_Toolbar (p. 1310)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 391
ACT XML Tags
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
context=
Context or combination of contexts (separated using '|') for the interface.
Type
System_String_ARRAY_
Remarks
This interface block will be taken into account only for specified context(s).
Examples
None.
Details
Mandatory
True
MultipleValue
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
392 of ANSYS, Inc. and its subsidiaries and affiliates.
<Interface>
Name
context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
liteAPI=
Specifies for what context or combinations of contexts (separated using '|') liteAPI should be invoked
Type
System_String_ARRAY_
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 393
ACT XML Tags
MultipleValue
True
Name
liteAPI
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
False
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
propertyEvents=
Specifies when property events should be invoked.
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
394 of ANSYS, Inc. and its subsidiaries and affiliates.
<Layout>
Details
Mandatory
False
MultipleValue
False
Name
propertyEvents
DefaultValue
UI
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Layout>
No details provided.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 395
ACT XML Tags
Examples
None.
Tag <Component> (p. 396) Defines the component for which the panel layout is being defined.
(inherited from Layout)
Attribute name= (p. 397) 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. 88)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_UI_Component
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
396 of ANSYS, Inc. and its subsidiaries and affiliates.
<Layout>
name=
Name of the layout. (inherited from Layout)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 397
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Layout>
Class defining the a new panel layout.
Remarks
None.
Examples
None.
Tag <Component> (p. 398) Defines the component for which the panel layout is being
defined.
Attribute name= (p. 399) Name of the layout.
<Component>
Defines the component for which the panel layout is being defined.
Type
Ansys_ACT_Core_XmlDataModel_UI_Component (p. 88)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_UI_Component
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
398 of ANSYS, Inc. and its subsidiaries and affiliates.
<Layout>
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
name=
Name of the layout.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 399
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Layout>
No details provided.
Remarks
None.
Examples
None.
Tag <Component> (p. 400) Defines the component for which the panel layout is being defined.
(inherited from Layout)
Attribute name= (p. 401) 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. 88)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
400 of ANSYS, Inc. and its subsidiaries and affiliates.
<Layout>
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_UI_Component
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
name=
Name of the layout. (inherited from Layout)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 401
ACT XML Tags
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Layout>
No details provided.
Remarks
None.
Examples
None.
Tag <Component> (p. 403) Defines the component for which the panel layout is being defined.
(inherited from Layout)
Attribute name= (p. 403) Name of the layout. (inherited from Layout)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
402 of ANSYS, Inc. and its subsidiaries and affiliates.
<Layout>
<Component>
Defines the component for which the panel layout is being defined. (inherited from Layout)
Type
Ansys_ACT_Core_XmlDataModel_UI_Component (p. 88)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_UI_Component
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
name=
Name of the layout. (inherited from Layout)
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 403
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<License>
Class defining a license to be used in the execution of an extension.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
404 of ANSYS, Inc. and its subsidiaries and affiliates.
<License>
Remarks
None.
Examples
None.
name=
Name of the license.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 405
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Licenses>
Class defining a licenses collection for the extension.
Remarks
None.
Examples
None.
<License>
A license collection defined for the extension.
Type
Ansys_ACT_Core_XmlDataModel_License (p. 404)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
406 of ANSYS, Inc. and its subsidiaries and affiliates.
<Link>
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Link>
Class defining a new application task link.
Remarks
None.
Examples
None.
Attribute from= (p. 408) The name of the task where the link come
from.
Attribute to= (p. 409) The name of the task where the link go
to.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 407
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
408 of ANSYS, Inc. and its subsidiaries and affiliates.
<Link>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
to=
The name of the task where the link go to.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
to
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 409
ACT XML Tags
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<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.
Examples
Example 1: The following example defines a load applicable to edges.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
410 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Callback <GetPostCommands> (p. 422) Callback that is invoked to collect all "post"
commands to add to the solver input file.
Callback <GetPreCommands> (p. 423) Callback that is invoked to collect all "pre"
commands to add to the solver input file.
Callback <GetSolveCommands> (p. 424) Callback that is invoked to collect all "solve"
commands to add to the solver input file.
Callback <IsValid> (p. 425) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 427) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGenerate> (p. 428) Callback that is invoked after the generation is
completed.
Callback <OnAfterGeometryUpdate> (p. 429) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 430) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 431) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDrawBodyViews> (p. 432) Called to collect all commands to add to the solver
input file.
Callback <OnDuplicate> (p. 434) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerate> (p. 435) Callback that is invoked when the load object is
generated.
Callback <OnGenerateData> (p. 436) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 437) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 438) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 439) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 440) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 442) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 443) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 444) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 445) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 446) No details provided. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 411
ACT XML Tags
Attribute AffectsSolution= (p. 447) Indicates whether the load object should affect
the solution or not.
Attribute BeginGroup= (p. 448) Indicates whether the load object will have a
separator before it when shown in the context
menu. (inherited from SimEntity)
Attribute caption= (p. 449) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 450) Class name of the controller of the object.
(inherited from SimEntity)
Attribute ClearDataOnPropertyChange= (p. 452) Indicates whether the generated data should be
cleared on property change.
Attribute color= (p. 453) Color of the scoped entities.
Attribute ContextGroup= (p. 454) Indicates which group the load will be shown in
the context menu. (inherited from SimEntity)
Attribute contextual= (p. 455) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute icon= (p. 456) Icon for the object. (inherited from SimEntity)
Attribute IsLoad= (p. 457) Indicates whether the load object should be
considered as a load boundary.
Attribute IsSupport= (p. 458) Indicates whether the load object should be
considered as a support boundary.
Attribute LazyActivateSelectProperties= (p. 459) Determines when onActivate callback is called for
the properties. (inherited from SimEntity)
Attribute localize= (p. 460) Indicates whether the caption and value string
need to be localized by the application. (inherited
from SimEntity)
Attribute name= (p. 461) Name of the object. (inherited from SimEntity)
Attribute unit= (p. 463) Default unit used by the contour display.
Attribute version= (p. 464) Version of the object. (inherited from SimEntity)
<Action>
No details provided.
Type
List_Action_
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
412 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Details
CallbackType
None.
Name
Action
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Attributes>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 413
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
414 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Name
CanAdd
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 415
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
416 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Name
CanCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 417
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
418 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 419
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
420 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetNodalValuesForDisplay>
Callback that is invoked to get nodal values associated with the load.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetNodeValues
Name
GetNodalValuesForDisplay
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 421
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetPostCommands>
Callback that is invoked to collect all "post" commands to add to the solver input file.
Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 70)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands
Name
GetPostCommands
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
422 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetPreCommands>
Callback that is invoked to collect all "pre" commands to add to the solver input file.
Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 70)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 423
ACT XML Tags
Name
GetPreCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetSolveCommands>
Callback that is invoked to collect all "solve" commands to add to the solver input file.
Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 70)
Remarks
If timeDependent is true, the callback take as argument : analysis, step, stream
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
424 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands
Name
GetSolveCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 425
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
426 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 427
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGenerate>
Callback that is invoked after the generation is completed.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnAfterGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
428 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 429
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
430 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 431
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDrawBodyViews>
Called to collect all commands to add to the solver input file.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
432 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDrawBodyViews
Name
OnDrawBodyViews
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 433
ACT XML Tags
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
434 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerate>
Callback that is invoked when the load object is generated.
Type
Ansys_ACT_Core_XmlDataModel_CallbackOnGenerate (p. 79)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnGenerate
Name
OnGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 435
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
436 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnHide
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 437
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
438 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
It enables the migration of data from the old saved object to the new one.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 439
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
440 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 441
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
442 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 443
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnSuppress
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
444 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnUnsuppress
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 445
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
446 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
AffectsSolution=
Indicates whether the load object should affect the solution or not.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
True
Name
AffectsSolution
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 447
ACT XML Tags
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
448 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Details
DefaultValue
False
Name
BeginGroup
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 449
ACT XML Tags
Examples
None.
Details
DefaultValue
None.
Name
caption
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
class=
Class name of the controller of the object. (inherited from SimEntity)
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
450 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Remarks
The constructor of the class referenced by this attribute takes two arguments:
Examples
None.
Details
DefaultValue
None.
Name
class
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 451
ACT XML Tags
ClearDataOnPropertyChange=
Indicates whether the generated data should be cleared on property change.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
True
Name
ClearDataOnPropertyChange
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
452 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Details
DefaultValue
#00ff00
Name
color
Mandatory
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 453
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
ContextGroup
Mandatory
False
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
454 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 455
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
icon
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
456 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
IsLoad=
Indicates whether the load object should be considered as a load boundary.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 457
ACT XML Tags
Name
IsLoad
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
IsSupport=
Indicates whether the load object should be considered as a support boundary.
Type
System_Boolean
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
458 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Details
DefaultValue
False
Name
IsSupport
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 459
ACT XML Tags
Examples
None.
Details
DefaultValue
False
Name
LazyActivateSelectProperties
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Type
System_Boolean
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
460 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
Remarks
None.
Examples
None.
Details
DefaultValue
False
Name
localize
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the object. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 461
ACT XML Tags
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
462 of ANSYS, Inc. and its subsidiaries and affiliates.
<Load>
unit=
Default unit used by the contour display.
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
unit
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 463
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
464 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<nativepropertytable>
Class encapsulating a list of child properties under one table.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 465
ACT XML Tags
Callback <OnDuplicate> (p. 481) Callback that is invoked when the property is
duplicated. (inherited from PropertyBase)
Callback <OnHide> (p. 482) Callback that is invoked when the property is
hidden. (inherited from PropertyBase)
Callback <OnInit> (p. 483) Callback that is invoked when the property is
initialized. (inherited from PropertyBase)
Callback <OnJournalExecuting> (p. 485) Callback that is invoked before executing an action
written in the journal. (inherited from
PropertyBase)
Callback <OnJournalRecording> (p. 486) Callback that is invoked before writting the journal
for an action. (inherited from PropertyBase)
Callback <OnMigrate> (p. 487) Callback that is invoked when the property version
has been changed. (inherited from PropertyBase)
Callback <OnRemove> (p. 488) Callback that is invoked when the property is
removed. (inherited from PropertyBase)
Callback <OnShow> (p. 489) Callback that is invoked when the property is
shown. (inherited from PropertyBase)
Callback <OnValidate> (p. 490) Callback that is invoked when the property is
validated. (inherited from PropertyBase)
Tag <Property> (p. 491) No details provided.
Callback <SetValue> (p. 492) Callback that is invoked when the property value
is set. (inherited from PropertyBase)
Callback <String2Value> (p. 493) Callback that is invoked to convert a string to the
property value. (inherited from PropertyBase)
Callback <Value2String> (p. 495) Callback that is invoked to convert the value
stored by the property into a string. (inherited
from PropertyBase)
Attribute allowempty= (p. 496) Unit type of the property (for float control).
Attribute caption= (p. 497) Caption of the property. (inherited from
PropertyBase)
Attribute class= (p. 498) Class name of the property's controller. (inherited
from PropertyBase)
Attribute control= (p. 499) Control type of the object.
Attribute default= (p. 500) Default value of the property. (inherited from
PropertyBase)
Attribute display= (p. 501) Display type of the property group.
Attribute elementtype= (p. 502) Property list element type (workflow). (inherited
from PropertyBase)
Attribute isparameter= (p. 504) Indicates whether the property is a parameter.
(inherited from PropertyBase)
Attribute keytype= (p. 505) Property dictionary key type (workflow). (inherited
from PropertyBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
466 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
Attribute localize= (p. 506) Indicates whether the caption and value string
need to be localized by the application. (inherited
from PropertyBase)
Attribute name= (p. 507) Name of the property. (inherited from
PropertyBase)
Attribute needupdate= (p. 508) Indicates whether the context must be refreshed
when the property value changes. (inherited from
PropertyBase)
Attribute parameterizable= (p. 509) 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. 510) Specifies the property persistence (workflow).
Indicates whether the property data should be
saved within the project. (inherited from
PropertyBase)
Attribute readonly= (p. 511) Indicates whether the property is read-only.
(inherited from PropertyBase)
Attribute unit= (p. 512) Unit type of the property (for 'control' equals to
'float' only). (inherited from PropertyBase)
Attribute valuetype= (p. 513) Property dictionary value type (workflow).
(inherited from PropertyBase)
Attribute visible= (p. 515) Indicates whether the property is visible. (inherited
from PropertyBase)
Attribute visibleon= (p. 516) 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
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 467
ACT XML Tags
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
468 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<GetValue>
Callback that is invoked when the property value is acquired. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 469
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<help>
No details provided. (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Description
Indicate the help that will be shown for the property. (Wizard only)
Name
help
ValueName
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
470 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute
<IsValid>
Callback that is invoked to determine whether the property is valid. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValid
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 471
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<IsVisible>
Callback that is invoked to determine whether the property is visible. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsVisible
Name
IsVisible
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
472 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnActivate>
Callback that is invoked when the property is activated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnActivate
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 473
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the property is added. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
474 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked after the geometry has been updated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 475
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnApply>
Callback that is invoked when the property apply button is clicked. (inherited from PropertyBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
476 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnApply
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 477
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state change. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
478 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnButtonClick>
Callback that is invoked when click on a property's button (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnButtonClick
Name
OnButtonClick
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 479
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnCancel>
Callback that is invoked when the property cancel button is clicked. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnCancel
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
480 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the property is duplicated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp
Name
OnDuplicate
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 481
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the property is hidden. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
482 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the property is initialized. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 483
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
484 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
<OnJournalExecuting>
Callback that is invoked before executing an action written in the journal. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnJournalExecuting
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 485
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnJournalRecording>
Callback that is invoked before writting the journal for an action. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnJournalRecording
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
486 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the property version has been changed. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 487
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the property is removed. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
Name
OnRemove
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
488 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the property is shown. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 489
ACT XML Tags
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnValidate>
Callback that is invoked when the property is validated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
490 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnValidate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 491
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<SetValue>
Callback that is invoked when the property value is set. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is useful for transforming the submitted property value.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
492 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue
Name
SetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<String2Value>
Callback that is invoked to convert a string to the property value. (inherited from PropertyBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 493
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_String2Value
Name
String2Value
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
494 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Value2String>
Callback that is invoked to convert the value stored by the property into a string. (inherited from
PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_Value2String
Name
Value2String
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 495
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
496 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the property. (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 497
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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:
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
498 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
control=
Control type of the object.
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 499
ACT XML Tags
Details
Mandatory
False
Name
control
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
default=
Default value of the property. (inherited from PropertyBase)
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
500 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
Examples
None.
Details
Mandatory
False
Name
default
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
display=
Display type of the property group.
Type
Ansys_ACT_Interfaces_UserObject_PropertyDisplayEnum
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 501
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
display
DefaultValue
Caption
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
elementtype=
Property list element type (workflow). (inherited from PropertyBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
502 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
elementtype
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 503
ACT XML Tags
isparameter=
Indicates whether the property is a parameter. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
isparameter
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
504 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
keytype=
Property dictionary key type (workflow). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
keytype
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 505
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
localize
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
506 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the property. (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 507
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
needupdate=
Indicates whether the context must be refreshed when the property value changes. (inherited from
PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
needupdate
DefaultValue
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
508 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 509
ACT XML Tags
Name
parameterizable
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
510 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
Details
Mandatory
False
Name
persistent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
readonly=
Indicates whether the property is read-only. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 511
ACT XML Tags
Examples
None.
Details
Mandatory
False
Name
readonly
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
unit=
Unit type of the property (for 'control' equals to 'float' only). (inherited from PropertyBase)
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
512 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
unit
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
valuetype=
Property dictionary value type (workflow). (inherited from PropertyBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 513
ACT XML Tags
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
514 of ANSYS, Inc. and its subsidiaries and affiliates.
<nativepropertytable>
visible=
Indicates whether the property is visible. (inherited from PropertyBase)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 515
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
System_String_ARRAY_
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
visibleon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
516 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Object>
Class defining an object.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 517
ACT XML Tags
Callback <IsValid> (p. 532) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 534) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGenerate> (p. 535) Called when the generation is completed.
Callback <OnAfterGeometryUpdate> (p. 536) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 537) Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 538) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDrawBodyViews> (p. 539) Called to collect all commands to add to the solver
input file.
Callback <OnDuplicate> (p. 540) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerate> (p. 542) Called when the load object is generated.
Callback <OnGenerateData> (p. 543) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 544) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 545) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 546) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 547) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 549) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 550) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 551) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 552) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 553) No details provided. (inherited from SimEntity)
Tag <Target> (p. 554) Defines the target location for the object.
Attribute AffectsSolution= (p. 555) Indicates whether the load object should affect
the solution or not.
Attribute BeginGroup= (p. 556) Indicates whether the load object will have a
separator before it when shown in the context
menu. (inherited from SimEntity)
Attribute caption= (p. 557) Caption of the object. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
518 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
Attribute class= (p. 558) Class name of the controller of the object.
(inherited from SimEntity)
Attribute ClearDataOnPropertyChange= (p. 559) Indicates whether the generated data should be
cleared on property change.
Attribute color= (p. 560) Color of scoped entities.
Attribute ContextGroup= (p. 561) Indicates which group the load will be shown in
the context menu. (inherited from SimEntity)
Attribute contextual= (p. 563) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute icon= (p. 564) Icon for the object. (inherited from SimEntity)
Attribute IsLoad= (p. 565) Indicates whether the load object should be
considered as a load boundary.
Attribute IsSupport= (p. 566) Indicates whether the load object should be
considered as a support boundary.
Attribute LazyActivateSelectProperties= (p. 567) Determines when onActivate callback is called for
the properties. (inherited from SimEntity)
Attribute localize= (p. 568) Indicates whether the caption and value string
need to be localized by the application. (inherited
from SimEntity)
Attribute name= (p. 569) Name of the object. (inherited from SimEntity)
Attribute unit= (p. 570) Default unit used by the contour display.
Attribute version= (p. 571) Version of the object. (inherited from SimEntity)
<Action>
No details provided.
Type
List_Action_
Remarks
None.
Examples
None.
Details
CallbackType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 519
ACT XML Tags
Name
Action
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Attributes>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
520 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 521
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Name
CanAdd
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
522 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 523
ACT XML Tags
Name
CanCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
524 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 525
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
526 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetCommands>
Called 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
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 527
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetNodalValuesForDisplay>
Called to get nodal values associated to the load.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetNodeValues
Name
GetNodalValuesForDisplay
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
528 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetPostCommands>
Called to collect all "post" commands to add to the solver input file.
Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 70)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands
Name
GetPostCommands
Public
True
Obsolete
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 529
ACT XML Tags
ObsoleteMessage
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetPreCommands>
Called to collect all "pre" commands to add to the solver input file.
Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 70)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands
Name
GetPreCommands
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
530 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetSolveCommands>
Called to collect all "solve" commands to add to the solver input file.
Type
Ansys_ACT_Core_XmlDataModel_CallbackGetPostPreSolveCommands (p. 70)
Remarks
If timeDependent is true, the callback take as argument : analysis, step, stream
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 531
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSolveCommands
Name
GetSolveCommands
Public
True
Obsolete
True
ObsoleteMessage
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
532 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 533
ACT XML Tags
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
534 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGenerate>
Called when the generation is completed.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnAfterGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 535
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
536 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 537
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
538 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDrawBodyViews>
Called to collect all commands to add to the solver input file.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 539
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDrawBodyViews
Name
OnDrawBodyViews
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
540 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 541
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerate>
Called when the load object is generated.
Type
Ansys_ACT_Core_XmlDataModel_CallbackOnGenerate (p. 79)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnGenerate
Name
OnGenerate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
542 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 543
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnHide
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
544 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnInit
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 545
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
It enables the migration of data from the old saved object to the new one.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
546 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 547
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
548 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 549
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
550 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 551
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnUnsuppress
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
552 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 553
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Target>
Defines the target location for the object.
Type
Ansys_ACT_Core_XmlDataModel_Target (p. 1199)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
554 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
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.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 555
ACT XML Tags
Public
False
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Name
BeginGroup
Mandatory
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
556 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
caption
Mandatory
False
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 557
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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:
Examples
None.
Details
DefaultValue
None.
Name
class
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
558 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ClearDataOnPropertyChange=
Indicates whether the generated data should be cleared on property change.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 559
ACT XML Tags
Name
ClearDataOnPropertyChange
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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:
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
560 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
White: #FFFFFF
Black: #000000
Red: #FF0000
Green: #00FF00
Blue: #0000FF
Details
DefaultValue
#00ff00
Name
color
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 561
ACT XML Tags
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
ContextGroup
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
562 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
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
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 563
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
564 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 565
ACT XML Tags
Public
False
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
566 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
MappedValues
None.
Public
False
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Name
LazyActivateSelectProperties
Mandatory
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 567
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Name
localize
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
568 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
name
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 569
ACT XML Tags
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
unit=
Default unit used by the contour display.
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
570 of ANSYS, Inc. and its subsidiaries and affiliates.
<Object>
Name
unit
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Version of the object. (inherited from SimEntity)
Type
System_Int32
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 571
ACT XML Tags
Details
DefaultValue
None.
Name
version
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<operator>
No details provided.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
572 of ANSYS, Inc. and its subsidiaries and affiliates.
<operator>
Examples
None.
<InputValue>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Language_InputValue (p. 352)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Language_InputValue
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 573
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Name=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
574 of ANSYS, Inc. and its subsidiaries and affiliates.
<operator>
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Type=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
Name
Type
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 575
ACT XML Tags
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Optimizer>
Class defining an optimizer.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
576 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 577
ACT XML Tags
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
578 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 579
ACT XML Tags
<Attributes>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
580 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 581
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Name
CanAdd
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
582 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 583
ACT XML Tags
Name
CanCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
584 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 585
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
586 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<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
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__bool_
Name
CanRun
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 587
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Configuration>
Callback that is invoked to return a userreadable string summarizing the current configuration of the
optimizer (or the sampling). (inherited from DesignExplorer)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__string_
Name
Configuration
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
588 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<ConvergenceDescription>
Callback that is invoked to return a DXConvergenceDescription object describing the convergence
data provided.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__object_
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 589
ACT XML Tags
Name
ConvergenceDescription
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Description>
Callback that is invoked to return a user-readable string describing the optimizer and its specific
capabilities. (inherited from DesignExplorer)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
590 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__string_
Name
Description
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<InputParametersEdited>
Callback that is invoked when the properties of input parameters have changed. (inherited from De-
signExplorer)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 591
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
InputParametersEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
592 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 593
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<MethodPropertiesEdited>
Callback that is invoked when the properties of the optimization method have changed. (inherited
from DesignExplorer)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
MethodPropertiesEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
594 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<ObjectivesOrConstraintsEdited>
Callback that is invoked when the definition of objectives or constraints have changed.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
ObjectivesOrConstraintsEdited
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 595
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is not invoked when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
596 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 597
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
598 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 599
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
600 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnCreate>
Callback that is invoked to provide an instance of IOptimizationMethod (or ISamplingMethod). (inherited
from DesignExplorer)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__object_
Name
OnCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 601
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnDuplicate
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
602 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 603
ACT XML Tags
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
604 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 605
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
606 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 607
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
608 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRelease>
Callback that is invoked to release the IOptimizationMethod (or the ISamplingMethod) instance. (in-
herited from DesignExplorer)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
OnRelease
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 609
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
610 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 611
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
612 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 613
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
614 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<ParameterRelationshipsEdited>
Callback that is invoked when the definition of parameter relationships have changed.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
ParameterRelationshipsEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 615
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
616 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<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
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__string_
Name
QuickHelp
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 617
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<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
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__string_
Name
Status
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
618 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
basedondirectoptimizationonly=
True if the optimizer is only available in the context of a Direct Optimization component; false other-
wise.
Type
System_Boolean
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 619
ACT XML Tags
Details
DefaultValue
False
Name
basedondirectoptimizationonly
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
basedonresponsesurfaceonly=
True if the optimizer is only available in the context of a Response Surface component; false otherwise.
Type
System_Boolean
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
620 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Examples
None.
Details
DefaultValue
False
Name
basedonresponsesurfaceonly
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Type
System_Boolean
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 621
ACT XML Tags
Remarks
None.
Examples
None.
Details
Name
BeginGroup
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the object. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
622 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 623
ACT XML Tags
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:
Examples
None.
Details
Name
class
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
624 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
constrainthandling=
Supports constraint handling.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Name
constrainthandling
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 625
ACT XML Tags
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
constraintimportance=
Supports the Importance property of a constraint.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Name
constraintimportance
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
626 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
constraintoninputparameter=
Supports constraints defined on an input parameter.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
True
Name
constraintoninputparameter
Mandatory
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 627
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
ContextGroup
Mandatory
False
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
628 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Name
contextual
Mandatory
False
DefaultValue
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 629
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
convergencedata=
Provides convergence data.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Name
convergencedata
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
630 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
equaltoconstraint=
Supports the Equal To constraint type.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 631
ACT XML Tags
Name
equaltoconstraint
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
greaterthanconstraint=
Supports the Greater Than constraint type.
Type
System_Boolean
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
632 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Details
DefaultValue
True
Name
greaterthanconstraint
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
gridintervaloninputparameter=
Supports grid interval defined on an Input Parameter.
Type
System_Boolean
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 633
ACT XML Tags
Examples
None.
Details
DefaultValue
False
Name
gridintervaloninputparameter
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
historychartxaxistype=
Defines the X axis type for history charts.
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
634 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Remarks
None.
Examples
None.
Details
DefaultValue
bypoint
Name
historychartxaxistype
Mandatory
False
DataDefinition
False
AllowedValues
System.String[]
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the object. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 635
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
636 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
insideboundsconstraint=
Supports the Inside Bounds constraint type.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
True
Name
insideboundsconstraint
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 637
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
LazyActivateSelectProperties
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
638 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
lessthanconstraint=
Supports the Less Than constraint type.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
True
Name
lessthanconstraint
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 639
ACT XML Tags
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
localize
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
640 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 641
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
maximizeobjective=
Supports the Maximize objective type.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
True
Name
maximizeobjective
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
642 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
maximumnumberofconstraints=
Defines the maximum number of constraints supported by the optimizer.
Type
System_Int32
Remarks
None.
Examples
None.
Details
DefaultValue
100
Name
maximumnumberofconstraints
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 643
ACT XML Tags
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
maximumnumberofdoublelistparameters=
Indicates the maximum number of double list parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Remarks
None.
Examples
None.
Details
DefaultValue
100
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
644 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Name
maximumnumberofdoublelistparameters
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
maximumnumberofdoubleparameters=
Indicates the maximum number of double parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 645
ACT XML Tags
Details
DefaultValue
100
Name
maximumnumberofdoubleparameters
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
maximumnumberofinputparameters=
Indicates the maximum number of input parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
646 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Examples
None.
Details
DefaultValue
100
Name
maximumnumberofinputparameters
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
maximumnumberofintegerlistparameters=
Indicates the maximum number of integer list parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 647
ACT XML Tags
Remarks
None.
Examples
None.
Details
DefaultValue
100
Name
maximumnumberofintegerlistparameters
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
maximumnumberofobjectives=
Defines the maximum number of objectives supported by the optimizer.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
648 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Type
System_Int32
Remarks
None.
Examples
None.
Details
DefaultValue
100
Name
maximumnumberofobjectives
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 649
ACT XML Tags
minimizeobjective=
Supports the Minimize objective type.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
True
Name
minimizeobjective
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
650 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
minimumnumberofconstraints=
Defines the minimum number of constraints required.
Type
System_Int32
Remarks
None.
Examples
None.
Details
DefaultValue
Name
minimumnumberofconstraints
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 651
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
minimumnumberofobjectives=
Defines the minimum number of objectives required.
Type
System_Int32
Remarks
None.
Examples
None.
Details
DefaultValue
Name
minimumnumberofobjectives
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
652 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 653
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
objectiveimportance=
Supports the Importance property of an objective.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Name
objectiveimportance
Mandatory
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
654 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
objectiveoninputparameter=
Supports objectives defined on an Input Parameter.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
True
Name
objectiveoninputparameter
Mandatory
False
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 655
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
parameterrelationship=
Supports parameter relationships.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Name
parameterrelationship
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
656 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
seekobjective=
Supports the Seek objective type.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
True
Name
seekobjective
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 657
ACT XML Tags
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
startingpointrequired=
Requires a Starting Point.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
658 of ANSYS, Inc. and its subsidiaries and affiliates.
<Optimizer>
Name
startingpointrequired
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Version of the object. (inherited from SimEntity)
Type
System_Int32
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 659
ACT XML Tags
Details
Name
version
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
660 of ANSYS, Inc. and its subsidiaries and affiliates.
<OrderableCallback>
Examples
None.
Attribute caninterrupt= (p. 661) Specifies whether the callback can be cancelled/interrupted.
(inherited from CallbackBase)
Attribute iscsharpstatic= (p. 662) Indicates whether the callback is a C Sharp static method. (inherited
from CallbackBase)
Attribute order= (p. 663) The order "priority". The lower the order, the earlier the execution.
caninterrupt=
Specifies whether the callback can be cancelled/interrupted. (inherited from CallbackBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caninterrupt
DefaultValue
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 661
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
iscsharpstatic=
Indicates whether the callback is a C Sharp static method. (inherited from CallbackBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
iscsharpstatic
DefaultValue
False
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
662 of ANSYS, Inc. and its subsidiaries and affiliates.
<OrderableCallback>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
order=
The order "priority". The lower the order, the earlier the execution.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
order
DefaultValue
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 663
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<output>
Class defining an output-level data connection definition.
Remarks
None.
Examples
None.
format=
Connection format type. (inherited from IOItem)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
664 of ANSYS, Inc. and its subsidiaries and affiliates.
<output>
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
Name
format
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 665
ACT XML Tags
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
Name
type
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
666 of ANSYS, Inc. and its subsidiaries and affiliates.
<outputfile>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<outputfile>
This class defines the OutputFile XML Tag.
Remarks
None.
Examples
None.
id=
The unique file id. (inherited from File)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
id
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 667
ACT XML Tags
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
The file name. (inherited from File)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
668 of ANSYS, Inc. and its subsidiaries and affiliates.
<outputs>
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<outputs>
Class defining the outputs collection for a task.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 669
ACT XML Tags
<Output>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Output (p. 664)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Output
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Panel>
Class defining a panel to be displayed in the application.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
670 of ANSYS, Inc. and its subsidiaries and affiliates.
<Panel>
Examples
None.
Tag <Callbacks> (p. 671) Specifies the callbacks that will invoke functions
from the IronPython extension script. (Inherited from
SimEntity)
Tag <DialogProgressMonitorView> (p. 672) No details provided.
Callback <OnPanelHidden> (p. 673) Callback that is invoked when the panel is hidden.
Callback <OnPanelInitialized> (p. 674) Callback that is invoked when the panel is initialized.
Callback <OnPanelShown> (p. 675) Callback that is invoked when the panel is shown.
Attribute class= (p. 676) Class name of the controller of the object.
Attribute layout= (p. 677) Layout of the panel.
Attribute name= (p. 678) Name of the panel.
<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script. (Inherited from
SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 671
ACT XML Tags
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<DialogProgressMonitorView>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Application_DialogProgressMonitorView (p. 148)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_DialogProgressMonitorView
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
672 of ANSYS, Inc. and its subsidiaries and affiliates.
<Panel>
<OnPanelHidden>
Callback that is invoked when the panel is hidden.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IPanelComponent_
Name
OnPanelHidden
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 673
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnPanelInitialized>
Callback that is invoked when the panel is initialized.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IPanelComponent_
Name
OnPanelInitialized
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
674 of ANSYS, Inc. and its subsidiaries and affiliates.
<Panel>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnPanelShown>
Callback that is invoked when the panel is shown.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IPanelComponent_
Name
OnPanelShown
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 675
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
class=
Class name of the controller of the object.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
676 of ANSYS, Inc. and its subsidiaries and affiliates.
<Panel>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
layout=
Layout of the panel.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
layout
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 677
ACT XML Tags
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the panel.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
678 of ANSYS, Inc. and its subsidiaries and affiliates.
<PanelComponent>
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<PanelComponent>
No details provided.
Remarks
None.
Examples
None.
Tag <Attributes> (p. 680) Defines the set of attributes for the component. (inherited
from Component)
Tag <Layout> (p. 681) No details provided.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 679
ACT XML Tags
<Attributes>
Defines the set of attributes for the component. (inherited from Component)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
680 of ANSYS, Inc. and its subsidiaries and affiliates.
<PanelComponent>
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Layout>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_UI_Layout (p. 398)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 681
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_UI_Layout
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<layoutName>
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Description
None.
Name
layoutName
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
682 of ANSYS, Inc. and its subsidiaries and affiliates.
<PanelComponent>
ValueName
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute
BottomAttachment=
Bottom attachment of the layout. (inherited from Component)
Type
System_String
Remarks
The value can be the name of a component or "" for the border.
Examples
None.
Details
Mandatory
False
Name
BottomAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 683
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
BottomOffset=
Bottom offset related to the bottom attachment. (inherited from Component)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
BottomOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
684 of ANSYS, Inc. and its subsidiaries and affiliates.
<PanelComponent>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ComponentType=
Type of the component for the component. (inherited from Component)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
ComponentType
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 685
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
CustomCSSFile=
Custom css file for the component layout. (inherited from Component)
Type
System_String
Remarks
This file will be taken in place of the standard one associated to the component.
Examples
None.
Details
Mandatory
False
Name
CustomCSSFile
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
686 of ANSYS, Inc. and its subsidiaries and affiliates.
<PanelComponent>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
CustomHTMLFile=
Custom html file for the component layout. (inherited from Component)
Type
System_String
Remarks
This file will be taken in place of the standard one associated to the component.
Examples
None.
Details
Mandatory
False
Name
CustomHTMLFile
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 687
ACT XML Tags
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
CustomJSFile=
Custom jscript file for the component layout. (inherited from Component)
Type
System_String
Remarks
This file will be taken in place of the standard one associated to the component.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
688 of ANSYS, Inc. and its subsidiaries and affiliates.
<PanelComponent>
Name
CustomJSFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Height=
Height value for the component. (inherited from Component)
Type
System_Single
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 689
ACT XML Tags
Details
Mandatory
True
Name
Height
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
HeightType=
Height type for the component. (inherited from Component)
Type
Ansys_ACT_Interfaces_UserInterface_ComponentLengthType
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
690 of ANSYS, Inc. and its subsidiaries and affiliates.
<PanelComponent>
Examples
None.
Details
Mandatory
True
Name
HeightType
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LeftAttachment=
Left attachment of the layout. (inherited from Component)
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 691
ACT XML Tags
Remarks
The value can be the name of a component or "" for the border.
Examples
None.
Details
Mandatory
False
Name
LeftAttachment
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LeftOffset=
Left offset related to the left attachment. (inherited from Component)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
692 of ANSYS, Inc. and its subsidiaries and affiliates.
<PanelComponent>
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
LeftOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 693
ACT XML Tags
MaxHeight=
Maximum height for the component. (inherited from Component)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
MaxHeight
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
694 of ANSYS, Inc. and its subsidiaries and affiliates.
<PanelComponent>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
MaxWidth=
Maximum width for the component. (inherited from Component)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
MaxWidth
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 695
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
MinHeight=
Minimum height for the component. (inherited from Component)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
MinHeight
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
696 of ANSYS, Inc. and its subsidiaries and affiliates.
<PanelComponent>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
MinWidth=
Minimum width for the component. (inherited from Component)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
MinWidth
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 697
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
698 of ANSYS, Inc. and its subsidiaries and affiliates.
<PanelComponent>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
RightAttachment=
Right attachment of the layout. (inherited from Component)
Type
System_String
Remarks
The value can be the name of a component or "" for the border.
Examples
None.
Details
Mandatory
False
Name
RightAttachment
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 699
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
RightOffset=
Right offset related to the right attachment. (inherited from Component)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
RightOffset
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
700 of ANSYS, Inc. and its subsidiaries and affiliates.
<PanelComponent>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
TopAttachment=
Top attachment of the layout. (inherited from Component)
Type
System_String
Remarks
The value can be the name of a component or "" for the border.
Examples
None.
Details
Mandatory
False
Name
TopAttachment
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 701
ACT XML Tags
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
TopOffset=
Top offset related to the top attachment. (inherited from Component)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
702 of ANSYS, Inc. and its subsidiaries and affiliates.
<PanelComponent>
Name
TopOffset
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
visible=
Initial visibility of the component. (inherited from Component)
Type
System_Boolean
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 703
ACT XML Tags
Details
Mandatory
False
Name
visible
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Width=
Width value for the component. (inherited from Component)
Type
System_Single
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
704 of ANSYS, Inc. and its subsidiaries and affiliates.
<PanelComponent>
Examples
None.
Details
Mandatory
True
Name
Width
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
WidthType=
Width type for the component. (inherited from Component)
Type
Ansys_ACT_Interfaces_UserInterface_ComponentLengthType
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 705
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
WidthType
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<parameter>
Class defining a single parameter definition for a task.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
706 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 707
ACT XML Tags
Callback <OnShow> (p. 728) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 730) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 731) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 732) No details provided. (inherited from SimEntity)
Attribute BeginGroup= (p. 733) Indicates whether the load object will have a
separator before it when shown in the context
menu. (inherited from SimEntity)
Attribute caption= (p. 734) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 735) Class name of the controller of the object.
(inherited from SimEntity)
Attribute ContextGroup= (p. 736) Indicates which group the load will be shown in
the context menu. (inherited from SimEntity)
Attribute contextual= (p. 737) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute control= (p. 738) Underlying data type of the parameter.
Attribute icon= (p. 739) Icon for the object. (inherited from SimEntity)
Attribute LazyActivateSelectProperties= (p. 740) Determines when onActivate callback is called for
the properties. (inherited from SimEntity)
Attribute localize= (p. 741) Indicates whether the caption and value string
need to be localized by the application. (inherited
from SimEntity)
Attribute name= (p. 743) Name of the object. (inherited from SimEntity)
Attribute usage= (p. 744) Usage of the parameter.
Attribute version= (p. 745) Version of the object. (inherited from SimEntity)
<Attributes>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
708 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 709
ACT XML Tags
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
710 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Name
CanCreate
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 711
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
712 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 713
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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
714 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 715
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
716 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 717
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
718 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 719
ACT XML Tags
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
720 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 721
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
722 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 723
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
724 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 725
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
726 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 727
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
728 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 729
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
730 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 731
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
RealParent
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
732 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
BeginGroup
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 733
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
caption
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
734 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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:
Examples
None.
Details
Name
class
Mandatory
False
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 735
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
ContextGroup
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
736 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Name
contextual
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 737
ACT XML Tags
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
control=
Underlying data type of the parameter.
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
738 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
Details
Name
control
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 739
ACT XML Tags
Examples
None.
Details
Name
icon
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
740 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
Remarks
None.
Examples
None.
Details
Name
LazyActivateSelectProperties
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 741
ACT XML Tags
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
localize
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
742 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
name=
Name of the object. (inherited from SimEntity)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 743
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
usage=
Usage of the parameter.
Type
System_String
Remarks
None.
Examples
None.
Details
Name
usage
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
744 of ANSYS, Inc. and its subsidiaries and affiliates.
<parameter>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Version of the object. (inherited from SimEntity)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
version
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 745
ACT XML Tags
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<parameters>
Class defining the collection of task parameters.
Remarks
None.
Examples
None.
<Parameter>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Parameter (p. 706)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Parameter
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
746 of ANSYS, Inc. and its subsidiaries and affiliates.
<platform>
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<platform>
This class defines the Platform XML Tag.
Remarks
None.
Examples
None.
name=
The platform name. May be "Win64" or "Linux64"
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 747
ACT XML Tags
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
path=
The platform-supported path (e.g., to an exe)
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
748 of ANSYS, Inc. and its subsidiaries and affiliates.
<Presentations>
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
path
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Presentations>
No details provided.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 749
ACT XML Tags
Remarks
None.
Examples
None.
<ScenePresentation>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Application_ScenePresentation (p. 1077)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_ScenePresentation
MinOccurence
MaxOccurence
-1
RealParent
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
750 of ANSYS, Inc. and its subsidiaries and affiliates.
<Presentations>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Name=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
Name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 751
ACT XML Tags
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<ProductDataModelConverter>
No details provided.
Remarks
None.
Examples
None.
<Callbacks>
No details provided.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
752 of ANSYS, Inc. and its subsidiaries and affiliates.
<ProductDataModelConverter>
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<OnReadInput>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 753
ACT XML Tags
Examples
None.
Details
CallbackType
ActionCallback_IApplicationDataModel__StreamReader_
Name
OnReadInput
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSendBackData>
No details provided.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
754 of ANSYS, Inc. and its subsidiaries and affiliates.
<ProductDataModelConverter>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_object__IExtAPI_
Name
OnSendBackData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 755
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSendData>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_object__IExtAPI_
Name
OnSendData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
756 of ANSYS, Inc. and its subsidiaries and affiliates.
<ProductDataModelConverter>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnWriteInput>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IApplicationDataModel__StreamWriter_
Name
OnWriteInput
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 757
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<UserObjectConverter>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Application_UserObjectConverter (p. 1367)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
758 of ANSYS, Inc. and its subsidiaries and affiliates.
<ProductDataModelConverter>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
dataModel=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
dataModel
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 759
ACT XML Tags
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
product=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
product
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
760 of ANSYS, Inc. and its subsidiaries and affiliates.
<ProductTask>
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<ProductTask>
Class defining a new user input application task.
Remarks
None.
Examples
None.
<DataModelInOut>
The panel associated to the task.
Type
Ansys_ACT_Core_XmlDataModel_Application_DataModelInOut (p. 132)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 761
ACT XML Tags
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_DataModelInOut
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
caption=
The caption of the task. (inherited from BaseTaskTag)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
762 of ANSYS, Inc. and its subsidiaries and affiliates.
<ProductTask>
Description
None.
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
The name of the task. (inherited from BaseTaskTag)
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 763
ACT XML Tags
Details
Mandatory
True
Description
None.
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
product=
The panel associated to the task.
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
764 of ANSYS, Inc. and its subsidiaries and affiliates.
<program>
Examples
None.
Details
Mandatory
True
Description
None.
Name
product
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<program>
This class defines the Program XML Tag.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 765
ACT XML Tags
Examples
None.
<Argument>
The program's command-line arguments.
Type
Ansys_ACT_Core_XmlDataModel_Argument (p. 48)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Argument
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
766 of ANSYS, Inc. and its subsidiaries and affiliates.
<projectdata>
<Platform>
The program's supported platforms.
Type
Ansys_ACT_Core_XmlDataModel_Platform (p. 747)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Platform
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
True
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<projectdata>
No details provided.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 767
ACT XML Tags
Examples
None.
<DataEntity>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_DataEntity (p. 150)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_DataEntity
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
768 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
<property>
Class defining a property of any user object.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 769
ACT XML Tags
Callback <OnJournalExecuting> (p. 788) Callback that is invoked before executing an action
written in the journal. (inherited from
PropertyBase)
Callback <OnJournalRecording> (p. 789) Callback that is invoked before writting the journal
for an action. (inherited from PropertyBase)
Callback <OnMigrate> (p. 791) Callback that is invoked when the property version
has been changed. (inherited from PropertyBase)
Callback <OnRemove> (p. 792) Callback that is invoked when the property is
removed. (inherited from PropertyBase)
Callback <OnShow> (p. 793) Callback that is invoked when the property is
shown. (inherited from PropertyBase)
Callback <OnValidate> (p. 794) Callback that is invoked when the property is
validated. (inherited from PropertyBase)
Callback <SetValue> (p. 795) Callback that is invoked when the property value
is set. (inherited from PropertyBase)
Callback <String2Value> (p. 796) Callback that is invoked to convert a string to the
property value. (inherited from PropertyBase)
Callback <Value2String> (p. 798) Callback that is invoked to convert the value
stored by the property into a string. (inherited
from PropertyBase)
Attribute caption= (p. 799) Caption of the property. (inherited from
PropertyBase)
Attribute class= (p. 800) Class name of the property's controller. (inherited
from PropertyBase)
Attribute control= (p. 801) Control type of the object.
Attribute default= (p. 802) Default value of the property. (inherited from
PropertyBase)
Attribute elementtype= (p. 803) Property list element type (workflow). (inherited
from PropertyBase)
Attribute isparameter= (p. 804) Indicates whether the property is a parameter.
(inherited from PropertyBase)
Attribute keytype= (p. 805) Property dictionary key type (workflow). (inherited
from PropertyBase)
Attribute localize= (p. 806) Indicates whether the caption and value string
need to be localized by the application. (inherited
from PropertyBase)
Attribute name= (p. 808) Name of the property. (inherited from
PropertyBase)
Attribute needupdate= (p. 809) Indicates whether the context must be refreshed
when the property value changes. (inherited from
PropertyBase)
Attribute parameterizable= (p. 810) Specifies the property parameterization (workflow).
Indicates whether the property should be a
candidate for parameterization (in the schematic
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
770 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
<Attributes>
No details provided. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 771
ACT XML Tags
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
772 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
<GetValue>
Callback that is invoked when the property value is acquired. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 773
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<help>
No details provided. (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Description
Indicate the help that will be shown for the property. (Wizard only)
Name
help
ValueName
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute
<IsValid>
Callback that is invoked to determine whether the property is valid. (inherited from PropertyBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
774 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValid
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 775
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<IsVisible>
Callback that is invoked to determine whether the property is visible. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsVisible
Name
IsVisible
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
776 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnActivate>
Callback that is invoked when the property is activated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnActivate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 777
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the property is added. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
Name
OnAdd
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
778 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked after the geometry has been updated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 779
ACT XML Tags
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnApply>
Callback that is invoked when the property apply button is clicked. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
780 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnApply
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state change. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 781
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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
782 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
<OnButtonClick>
Callback that is invoked when click on a property's button (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnButtonClick
Name
OnButtonClick
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 783
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnCancel>
Callback that is invoked when the property cancel button is clicked. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnCancel
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
784 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the property is duplicated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 785
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the property is hidden. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
Name
OnHide
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
786 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the property is initialized. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 787
ACT XML Tags
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnJournalExecuting>
Callback that is invoked before executing an action written in the journal. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
788 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnJournalExecuting
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnJournalRecording>
Callback that is invoked before writting the journal for an action. (inherited from PropertyBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 789
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnJournalRecording
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
790 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the property version has been changed. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 791
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the property is removed. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
792 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the property is shown. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
Name
OnShow
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 793
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnValidate>
Callback that is invoked when the property is validated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnValidate
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
794 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<SetValue>
Callback that is invoked when the property value is set. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is useful for transforming the submitted property value.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 795
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue
Name
SetValue
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<String2Value>
Callback that is invoked to convert a string to the property value. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
796 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_String2Value
Name
String2Value
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 797
ACT XML Tags
<Value2String>
Callback that is invoked to convert the value stored by the property into a string. (inherited from
PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_Value2String
Name
Value2String
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
798 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
caption=
Caption of the property. (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 799
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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:
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
800 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
control=
Control type of the object.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
control
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 801
ACT XML Tags
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
default=
Default value of the property. (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
802 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
Name
default
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
elementtype=
Property list element type (workflow). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 803
ACT XML Tags
Details
Mandatory
False
Name
elementtype
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
isparameter=
Indicates whether the property is a parameter. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
804 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
Examples
None.
Details
Mandatory
False
Name
isparameter
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
keytype=
Property dictionary key type (workflow). (inherited from PropertyBase)
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 805
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
keytype
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from PropertyBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
806 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
localize
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 807
ACT XML Tags
name=
Name of the property. (inherited from PropertyBase)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
808 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
needupdate=
Indicates whether the context must be refreshed when the property value changes. (inherited from
PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
needupdate
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 809
ACT XML Tags
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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.
Examples
None.
Details
Mandatory
False
Name
parameterizable
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
810 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Mandatory
False
Name
persistent
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 811
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
readonly=
Indicates whether the property is read-only. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
readonly
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
812 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
unit=
Unit type of the property (for 'control' equals to 'float' only). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 813
ACT XML Tags
Name
unit
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
valuetype=
Property dictionary value type (workflow). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
814 of ANSYS, Inc. and its subsidiaries and affiliates.
<property>
Details
Mandatory
False
Name
valuetype
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
visible=
Indicates whether the property is visible. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 815
ACT XML Tags
Examples
None.
Details
Mandatory
False
Name
visible
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
System_String_ARRAY_
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
816 of ANSYS, Inc. and its subsidiaries and affiliates.
<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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<propertygroup>
Class defining a collection of properties.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 817
ACT XML Tags
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
818 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
Callback <OnMigrate> (p. 840) Callback that is invoked when the property version
has been changed. (inherited from PropertyBase)
Callback <OnRemove> (p. 841) Callback that is invoked when the property is
removed. (inherited from PropertyBase)
Callback <OnShow> (p. 842) Callback that is invoked when the property is
shown. (inherited from PropertyBase)
Callback <OnValidate> (p. 843) Callback that is invoked when the property is
validated. (inherited from PropertyBase)
Tag <Property> (p. 844) No details provided.
Callback <SetValue> (p. 845) Callback that is invoked when the property value
is set. (inherited from PropertyBase)
Callback <String2Value> (p. 846) Callback that is invoked to convert a string to the
property value. (inherited from PropertyBase)
Callback <Value2String> (p. 847) Callback that is invoked to convert the value
stored by the property into a string. (inherited
from PropertyBase)
Attribute caption= (p. 849) Caption of the property. (inherited from
PropertyBase)
Attribute class= (p. 850) Class name of the property's controller. (inherited
from PropertyBase)
Attribute control= (p. 851) Control type of the object.
Attribute default= (p. 852) Default value of the property. (inherited from
PropertyBase)
Attribute display= (p. 853) Display type of the property group.
Attribute elementtype= (p. 854) Property list element type (workflow). (inherited
from PropertyBase)
Attribute isparameter= (p. 855) Indicates whether the property is a parameter.
(inherited from PropertyBase)
Attribute keytype= (p. 856) Property dictionary key type (workflow). (inherited
from PropertyBase)
Attribute localize= (p. 857) Indicates whether the caption and value string
need to be localized by the application. (inherited
from PropertyBase)
Attribute name= (p. 858) Name of the property. (inherited from
PropertyBase)
Attribute needupdate= (p. 859) Indicates whether the context must be refreshed
when the property value changes. (inherited from
PropertyBase)
Attribute parameterizable= (p. 861) 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)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 819
ACT XML Tags
<Attributes>
No details provided. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
820 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 821
ACT XML Tags
<GetValue>
Callback that is invoked when the property value is acquired. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
822 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<help>
No details provided. (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Description
Indicate the help that will be shown for the property. (Wizard only)
Name
help
ValueName
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute
<IsValid>
Callback that is invoked to determine whether the property is valid. (inherited from PropertyBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 823
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValid
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
824 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<IsVisible>
Callback that is invoked to determine whether the property is visible. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsVisible
Name
IsVisible
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 825
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnActivate>
Callback that is invoked when the property is activated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnActivate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
826 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the property is added. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
Name
OnAdd
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 827
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked after the geometry has been updated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
828 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnApply>
Callback that is invoked when the property apply button is clicked. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 829
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnApply
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state change. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
830 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 831
ACT XML Tags
<OnButtonClick>
Callback that is invoked when click on a property's button (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnButtonClick
Name
OnButtonClick
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
832 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnCancel>
Callback that is invoked when the property cancel button is clicked. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnCancel
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 833
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the property is duplicated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
834 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the property is hidden. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
Name
OnHide
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 835
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the property is initialized. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
836 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnJournalExecuting>
Callback that is invoked before executing an action written in the journal. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 837
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnJournalExecuting
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnJournalRecording>
Callback that is invoked before writting the journal for an action. (inherited from PropertyBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
838 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnJournalRecording
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 839
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the property version has been changed. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
840 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the property is removed. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 841
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the property is shown. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
Name
OnShow
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
842 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnValidate>
Callback that is invoked when the property is validated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnValidate
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 843
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
844 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<SetValue>
Callback that is invoked when the property value is set. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is useful for transforming the submitted property value.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue
Name
SetValue
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 845
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<String2Value>
Callback that is invoked to convert a string to the property value. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
846 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
Details
CallbackType
Ansys_ACT_Core_Callbacks_String2Value
Name
String2Value
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Value2String>
Callback that is invoked to convert the value stored by the property into a string. (inherited from
PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 847
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_Value2String
Name
Value2String
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
848 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
caption=
Caption of the property. (inherited from PropertyBase)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 849
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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:
Examples
None.
Details
DefaultValue
None.
Name
class
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
850 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
control=
Control type of the object.
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
control
Mandatory
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 851
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
default=
Default value of the property. (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
default
Mandatory
False
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
852 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
display=
Display type of the property group.
Type
Ansys_ACT_Interfaces_UserObject_PropertyDisplayEnum
Remarks
None.
Examples
None.
Details
DefaultValue
Caption
Name
display
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 853
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
elementtype=
Property list element type (workflow). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
elementtype
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
854 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
isparameter=
Indicates whether the property is a parameter. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 855
ACT XML Tags
Name
isparameter
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
keytype=
Property dictionary key type (workflow). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
856 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
Details
DefaultValue
None.
Name
keytype
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from PropertyBase)
Type
System_Boolean
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 857
ACT XML Tags
Examples
None.
Details
DefaultValue
False
Name
localize
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the property. (inherited from PropertyBase)
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
858 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
name
Mandatory
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
needupdate=
Indicates whether the context must be refreshed when the property value changes. (inherited from
PropertyBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 859
ACT XML Tags
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
True
Name
needupdate
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
860 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
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.
Examples
None.
Details
DefaultValue
None.
Name
parameterizable
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 861
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
DefaultValue
None.
Name
persistent
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
862 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
readonly=
Indicates whether the property is read-only. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
False
Name
readonly
Mandatory
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 863
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
unit=
Unit type of the property (for 'control' equals to 'float' only). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
unit
Mandatory
False
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
864 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
valuetype=
Property dictionary value type (workflow). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
DefaultValue
None.
Name
valuetype
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 865
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
visible=
Indicates whether the property is visible. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
DefaultValue
True
Name
visible
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
866 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertygroup>
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
System_String_ARRAY_
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 867
ACT XML Tags
Details
DefaultValue
None.
Name
visibleon
Mandatory
False
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<propertytable>
Class encapsulating a list of child properties under one table.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
868 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 869
ACT XML Tags
Callback <OnShow> (p. 893) Callback that is invoked when the property is
shown. (inherited from PropertyBase)
Callback <OnValidate> (p. 894) Callback that is invoked when the property is
validated. (inherited from PropertyBase)
Tag <Property> (p. 895) No details provided.
Callback <SetValue> (p. 896) Callback that is invoked when the property value
is set. (inherited from PropertyBase)
Callback <String2Value> (p. 897) Callback that is invoked to convert a string to the
property value. (inherited from PropertyBase)
Callback <Value2String> (p. 898) Callback that is invoked to convert the value
stored by the property into a string. (inherited
from PropertyBase)
Attribute allowempty= (p. 899) Unit type of the property (for float control).
Attribute caption= (p. 900) Caption of the property. (inherited from
PropertyBase)
Attribute class= (p. 902) Class name of the property's controller. (inherited
from PropertyBase)
Attribute control= (p. 903) Control type of the property table (e.g. tabulardata,
custom, etc.)
Attribute default= (p. 904) Default value of the property. (inherited from
PropertyBase)
Attribute display= (p. 905) Display type of the property table.
Attribute elementtype= (p. 906) Property list element type (workflow). (inherited
from PropertyBase)
Attribute isparameter= (p. 907) Indicates whether the property is a parameter.
(inherited from PropertyBase)
Attribute keytype= (p. 908) Property dictionary key type (workflow). (inherited
from PropertyBase)
Attribute localize= (p. 909) Indicates whether the caption and value string
need to be localized by the application. (inherited
from PropertyBase)
Attribute name= (p. 910) Name of the property. (inherited from
PropertyBase)
Attribute needupdate= (p. 911) Indicates whether the context must be refreshed
when the property value changes. (inherited from
PropertyBase)
Attribute parameterizable= (p. 913) 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. 914) Specifies the property persistence (workflow).
Indicates whether the property data should be
saved within the project. (inherited from
PropertyBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
870 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
<Attributes>
No details provided. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 871
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<GetValue>
Callback that is invoked when the property value is acquired. (inherited from PropertyBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
872 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 873
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<help>
No details provided. (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Description
Indicate the help that will be shown for the property. (Wizard only)
Name
help
ValueName
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute
<IsValid>
Callback that is invoked to determine whether the property is valid. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
874 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValid
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 875
ACT XML Tags
<IsVisible>
Callback that is invoked to determine whether the property is visible. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsVisible
Name
IsVisible
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
876 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnActivate>
Callback that is invoked when the property is activated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnActivate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 877
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the property is added. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
878 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked after the geometry has been updated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 879
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnApply>
Callback that is invoked when the property apply button is clicked. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
880 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
Name
OnApply
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state change. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 881
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnButtonClick>
Callback that is invoked when click on a property's button (inherited from PropertyBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
882 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnButtonClick
Name
OnButtonClick
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 883
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnCancel>
Callback that is invoked when the property cancel button is clicked. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnCancel
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
884 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the property is duplicated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 885
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the property is hidden. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
Name
OnHide
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
886 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the property is initialized. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitProp
Name
OnInit
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 887
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnJournalExecuting>
Callback that is invoked before executing an action written in the journal. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
888 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnJournalExecuting
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnJournalRecording>
Callback that is invoked before writting the journal for an action. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 889
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnJournalRecording
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
890 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
<OnMigrate>
Callback that is invoked when the property version has been changed. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 891
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the property is removed. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemoveProperty
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
892 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the property is shown. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHideProp
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 893
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnValidate>
Callback that is invoked when the property is validated. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnActivate
Name
OnValidate
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
894 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 895
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<SetValue>
Callback that is invoked when the property value is set. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is useful for transforming the submitted property value.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSetPropValue
Name
SetValue
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
896 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<String2Value>
Callback that is invoked to convert a string to the property value. (inherited from PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_String2Value
Name
String2Value
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 897
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Value2String>
Callback that is invoked to convert the value stored by the property into a string. (inherited from
PropertyBase)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
898 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
Details
CallbackType
Ansys_ACT_Core_Callbacks_Value2String
Name
Value2String
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
allowempty=
Unit type of the property (for float control).
Type
System_Boolean
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 899
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
allowempty
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the property. (inherited from PropertyBase)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
900 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 901
ACT XML Tags
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:
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
902 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 903
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
default=
Default value of the property. (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
default
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
904 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
display=
Display type of the property table.
Type
Ansys_ACT_Interfaces_UserObject_PropertyDisplayEnum
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
display
DefaultValue
Worksheet
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 905
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
elementtype=
Property list element type (workflow). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
elementtype
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
906 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
isparameter=
Indicates whether the property is a parameter. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
isparameter
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 907
ACT XML Tags
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
keytype=
Property dictionary key type (workflow). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
908 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
Name
keytype
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 909
ACT XML Tags
Details
Mandatory
False
Name
localize
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the property. (inherited from PropertyBase)
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
910 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
needupdate=
Indicates whether the context must be refreshed when the property value changes. (inherited from
PropertyBase)
Type
System_Boolean
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 911
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
needupdate
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
912 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
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.
Examples
None.
Details
Mandatory
False
Name
parameterizable
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 913
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Mandatory
False
Name
persistent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
914 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
readonly=
Indicates whether the property is read-only. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
readonly
DefaultValue
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 915
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
unit=
Unit type of the property (for 'control' equals to 'float' only). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
unit
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
916 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
valuetype=
Property dictionary value type (workflow). (inherited from PropertyBase)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
valuetype
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 917
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
visible=
Indicates whether the property is visible. (inherited from PropertyBase)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
visible
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
918 of ANSYS, Inc. and its subsidiaries and affiliates.
<propertytable>
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
System_String_ARRAY_
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 919
ACT XML Tags
Details
Mandatory
False
Name
visibleon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Result>
Class defining a result.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
920 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 921
ACT XML Tags
Callback <OnInit> (p. 945) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 946) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 947) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 949) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 950) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnStartEval> (p. 951) Callback that is invoked when the evaluation
process for a given step starts.
Callback <OnStartPost> (p. 952) Callback that is invoked when the post process
starts.
Callback <OnSuppress> (p. 953) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 954) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 956) No details provided. (inherited from SimEntity)
Attribute averaging= (p. 956) Averaging of the result.
Attribute BeginGroup= (p. 957) Indicates whether the load object will have a
separator before it when shown in the context
menu. (inherited from SimEntity)
Attribute caption= (p. 959) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 960) Class name of the controller of the object.
(inherited from SimEntity)
Attribute ContextGroup= (p. 961) Indicates which group the load will be shown in
the context menu. (inherited from SimEntity)
Attribute contextual= (p. 962) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute hasimaginary= (p. 963) Indicates whether the result supports imaginary
values.
Attribute icon= (p. 964) Icon for the object. (inherited from SimEntity)
Attribute iscontactresult= (p. 965) Indicates whether the result object should be
considered as a contact result or not.
Attribute LazyActivateSelectProperties= (p. 966) Determines when onActivate callback is called for
the properties. (inherited from SimEntity)
Attribute localize= (p. 967) Indicates whether the caption and value string
need to be localized by the application. (inherited
from SimEntity)
Attribute location= (p. 968) Location of the result.
Attribute name= (p. 969) Name of the object. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
922 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
Attribute timehistory= (p. 970) Indicates whether the time history has to be
calculated.
Attribute type= (p. 972) Type of the result.
Attribute unit= (p. 973) Unit used by the contour display.
Attribute version= (p. 974) Version of the object. (inherited from SimEntity)
<Action>
No details provided.
Type
List_Action_
Remarks
None.
Examples
None.
Details
CallbackType
None.
Name
Action
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 923
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Attributes>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
924 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 925
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
926 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Name
CanCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 927
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
928 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Name
CanRemove
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 929
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Evaluate>
Callback that is invoked when the step described by stepInfo is evaluated.
Type
Ansys_ACT_Core_XmlDataModel_CallbackEvaluate (p. 60)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_Evaluate
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
930 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
Name
Evaluate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetFieldCount>
Callback that is invoked to get the number of fields (ie components) for a given element or node ID.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 931
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetFieldCount
Name
GetFieldCount
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetValue>
Callback that is invoked to get the values associated to a node or an element given by its ID.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
932 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetValue
Name
GetValue
Public
True
Obsolete
True
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 933
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
934 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 935
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
936 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 937
ACT XML Tags
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
938 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 939
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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
940 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
<OnEndEval>
Callback that is invoked at the end of the evaluation process for a given step.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_StartEndEval
Name
OnEndEval
Public
True
Obsolete
True
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 941
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnEndPost>
Callback that is invoked at the end of the post process.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserResult_
Name
OnEndPost
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
942 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 943
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnHide
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
944 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 945
ACT XML Tags
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
It enables the migration of data from the old saved object to the new one.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
946 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 947
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
948 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 949
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
950 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnStartEval>
Callback that is invoked when the evaluation process for a given step starts.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_StartEndEval
Name
OnStartEval
Public
True
Obsolete
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 951
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnStartPost>
Callback that is invoked when the post process starts.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserResult_
Name
OnStartPost
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
952 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 953
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
954 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 955
ACT XML Tags
<Property>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
averaging=
Averaging of the result.
Type
Ansys_ACT_Interfaces_Post_ResultAveragingEnum
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
956 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
averaging
DefaultValue
Unaverage
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 957
ACT XML Tags
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
BeginGroup
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
958 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
caption=
Caption of the object. (inherited from SimEntity)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 959
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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:
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
960 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
ContextGroup
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 961
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
962 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
hasimaginary=
Indicates whether the result supports imaginary values.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
hasimaginary
DefaultValue
True
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 963
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
964 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 965
ACT XML Tags
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
966 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
Name
LazyActivateSelectProperties
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 967
ACT XML Tags
Details
Mandatory
False
Name
localize
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
location=
Location of the result.
Type
Ansys_ACT_Interfaces_Post_ResultLocationEnum
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
968 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
Examples
None.
Details
Mandatory
True
Name
location
DefaultValue
None.
DataDefinition
False
AllowedValues
System.String[]
MultipleValue
False
MappedValues
System.Object[]
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the object. (inherited from SimEntity)
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 969
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
timehistory=
Indicates whether the time history has to be calculated.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
970 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 971
ACT XML Tags
type=
Type of the result.
Type
Ansys_ACT_Interfaces_Post_ResultTypeEnum
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
type
DefaultValue
None.
DataDefinition
False
AllowedValues
System.String[]
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
972 of ANSYS, Inc. and its subsidiaries and affiliates.
<Result>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
unit=
Unit used by the contour display.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
unit
DefaultValue
Dimensionless
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 973
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Version of the object. (inherited from SimEntity)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
974 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<rsmjob>
This class defines an rsm job.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 975
ACT XML Tags
Callback <OnClearData> (p. 989) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <oncreatejobinput> (p. 990) This callback handles the generation of all input
files defined on the rsm job.
Callback <OnDuplicate> (p. 991) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 992) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 993) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 994) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <onjobcancellation> (p. 996) This callback handles a user-invoked job
cancellation.
Callback <onjobreconnect> (p. 997) 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. 998) This callback handles the status polling engaged
by the Framework. Return True to indicate the job
has completed.
Callback <OnMigrate> (p. 999) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 1000) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 1002) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 1003) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 1004) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 1005) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <OutputFile> (p. 1006) The job output files.
Tag <Program> (p. 1007) The programs to run by the rsm job. Currently
only one program per job allowed.
Tag <Property> (p. 1008) No details provided. (inherited from SimEntity)
Attribute BeginGroup= (p. 1009) Indicates whether the load object will have a
separator before it when shown in the context
menu. (inherited from SimEntity)
Attribute caption= (p. 1010) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 1011) Class name of the controller of the object.
(inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
976 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
Attribute ContextGroup= (p. 1012) Indicates which group the load will be shown in
the context menu. (inherited from SimEntity)
Attribute contextual= (p. 1013) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute deletefiles= (p. 1014) Indicates whether ACT should delete all rsmJob
input and output files upon successful completion
or job cancellation.
Attribute icon= (p. 1015) Icon for the object. (inherited from SimEntity)
Attribute LazyActivateSelectProperties= (p. 1016) Determines when onActivate callback is called for
the properties. (inherited from SimEntity)
Attribute localize= (p. 1017) Indicates whether the caption and value string
need to be localized by the application. (inherited
from SimEntity)
Attribute name= (p. 1018) Name of the object. (inherited from SimEntity)
Attribute version= (p. 1020) Version of the object. (inherited from SimEntity)
<Attributes>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 977
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
978 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 979
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Name
CanCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
980 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 981
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Name
CanRemove
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
982 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<InputFile>
The job input files.
Type
Ansys_ACT_Core_XmlDataModel_InputFile (p. 341)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 983
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_InputFile
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
984 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is not invoked when the project is reopened.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 985
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
986 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 987
ACT XML Tags
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
988 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 989
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<oncreatejobinput>
This callback handles the generation of all input files defined on the rsm job.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__List_string__
Name
oncreatejobinput
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
990 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnDuplicate
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 991
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
992 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 993
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
994 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 995
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onjobcancellation>
This callback handles a user-invoked job cancellation.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__List_string___List_string__
Name
onjobcancellation
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
996 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<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
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__List_string__
Name
onjobreconnect
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 997
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onjobstatus>
This callback handles the status polling engaged by the Framework. Return True to indicate the job
has completed.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__List_string___bool_
Name
onjobstatus
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
998 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
It enables the migration of data from the old saved object to the new one.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 999
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1000 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1001
ACT XML Tags
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1002 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1003
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1004 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnUnsuppress
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1005
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OutputFile>
The job output files.
Type
Ansys_ACT_Core_XmlDataModel_OutputFile (p. 667)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_OutputFile
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1006 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Program>
The programs to run by the rsm job. Currently only one program per job allowed.
Type
Ansys_ACT_Core_XmlDataModel_Program (p. 765)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Program
MinOccurence
MaxOccurence
RealParent
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1007
ACT XML Tags
Mandatory
True
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Property>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1008 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
BeginGroup
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1009
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1010 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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:
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1011
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
ContextGroup
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1012 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Mandatory
False
Name
contextual
DefaultValue
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1013
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
deletefiles=
Indicates whether ACT should delete all rsmJob input and output files upon successful completion
or job cancellation.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1014 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
Name
deletefiles
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1015
ACT XML Tags
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1016 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
Examples
None.
Details
Mandatory
False
Name
LazyActivateSelectProperties
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Type
System_Boolean
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1017
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
localize
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the object. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1018 of ANSYS, Inc. and its subsidiaries and affiliates.
<rsmjob>
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1019
ACT XML Tags
version=
Version of the object. (inherited from SimEntity)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1020 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Sampling>
Class defining a DesignXplorer Sampling.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1021
ACT XML Tags
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1022 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1023
ACT XML Tags
Attribute localize= (p. 1068) Indicates whether the caption and value
string need to be localized by the
application. (inherited from SimEntity)
Attribute logfile= (p. 1069) Provides messages to generate a log file.
(inherited from DesignExplorer)
Attribute maximumnumberofdoublelistparameters= (p. 1070)Indicates the maximum number of
double list parameters supported.
(inherited from DesignExplorer)
Attribute maximumnumberofdoubleparameters= (p. 1071) Indicates the maximum number of
double parameters supported. (inherited
from DesignExplorer)
Attribute maximumnumberofinputparameters= (p. 1072) Indicates the maximum number of input
parameters supported. (inherited from
DesignExplorer)
Attribute maximumnumberofintegerlistparameters= (p. 1073)Indicates the maximum number of
integer list parameters supported.
(inherited from DesignExplorer)
Attribute name= (p. 1074) Name of the object. (inherited from
SimEntity)
Attribute version= (p. 1076) Version of the object. (inherited from
SimEntity)
<Attributes>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1024 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1025
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1026 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Name
CanCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1027
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1028 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1029
ACT XML Tags
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<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
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1030 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__bool_
Name
CanRun
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Configuration>
Callback that is invoked to return a userreadable string summarizing the current configuration of the
optimizer (or the sampling). (inherited from DesignExplorer)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1031
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__string_
Name
Configuration
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1032 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Description>
Callback that is invoked to return a user-readable string describing the optimizer and its specific
capabilities. (inherited from DesignExplorer)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__string_
Name
Description
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1033
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<InputParametersEdited>
Callback that is invoked when the properties of input parameters have changed. (inherited from De-
signExplorer)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
InputParametersEdited
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1034 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1035
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<MethodPropertiesEdited>
Callback that is invoked when the properties of the optimization method have changed. (inherited
from DesignExplorer)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1036 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
Details
CallbackType
ActionCallback_IUserObject_
Name
MethodPropertiesEdited
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1037
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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1038 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1039
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1040 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1041
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnCreate>
Callback that is invoked to provide an instance of IOptimizationMethod (or ISamplingMethod). (inherited
from DesignExplorer)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__object_
Name
OnCreate
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1042 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1043
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1044 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1045
ACT XML Tags
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1046 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1047
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1048 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1049
ACT XML Tags
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRelease>
Callback that is invoked to release the IOptimizationMethod (or the ISamplingMethod) instance. (in-
herited from DesignExplorer)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1050 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
Details
CallbackType
ActionCallback_IUserObject_
Name
OnRelease
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1051
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1052 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1053
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1054 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1055
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1056 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<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
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__string_
Name
QuickHelp
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1057
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<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
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__string_
Name
Status
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1058 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1059
ACT XML Tags
Details
Name
BeginGroup
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1060 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
Examples
None.
Details
Name
caption
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
class=
Class name of the controller of the object. (inherited from SimEntity)
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1061
ACT XML Tags
Remarks
The constructor of the class referenced by this attribute takes two arguments:
Examples
None.
Details
Name
class
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1062 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
ContextGroup
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1063
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Name
contextual
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1064 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
CustomTable=
Supports custom table points.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
CustomTable
Mandatory
False
DefaultValue
False
DataDefinition
True
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1065
ACT XML Tags
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
icon
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1066 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
LazyActivateSelectProperties
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1067
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
localize
Mandatory
False
DefaultValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1068 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
logfile=
Provides messages to generate a log file. (inherited from DesignExplorer)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
logfile
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1069
ACT XML Tags
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
maximumnumberofdoublelistparameters=
Indicates the maximum number of double list parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
maximumnumberofdoublelistparameters
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1070 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
Mandatory
False
DefaultValue
100
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
maximumnumberofdoubleparameters=
Indicates the maximum number of double parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1071
ACT XML Tags
Details
Name
maximumnumberofdoubleparameters
Mandatory
False
DefaultValue
100
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
maximumnumberofinputparameters=
Indicates the maximum number of input parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1072 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
Examples
None.
Details
Name
maximumnumberofinputparameters
Mandatory
False
DefaultValue
100
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
maximumnumberofintegerlistparameters=
Indicates the maximum number of integer list parameters supported. (inherited from DesignExplorer)
Type
System_Int32
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1073
ACT XML Tags
Remarks
None.
Examples
None.
Details
Name
maximumnumberofintegerlistparameters
Mandatory
False
DefaultValue
100
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the object. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1074 of ANSYS, Inc. and its subsidiaries and affiliates.
<Sampling>
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1075
ACT XML Tags
version=
Version of the object. (inherited from SimEntity)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
version
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1076 of ANSYS, Inc. and its subsidiaries and affiliates.
<Scene>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Scene>
No details provided.
Remarks
None.
Examples
None.
Tag <Callbacks> (p. 1077) Specifies the callbacks that will invoke functions from the
IronPython extension script. (inherited from Presentation)
Callback <OnAdd> (p. 1078) No details provided. (inherited from Presentation)
Callback <OnDelete> (p. 1079) No details provided. (inherited from Presentation)
Callback <OnHighlight> (p. 1080) No details provided. (inherited from Presentation)
Callback <OnUnhighlight> (p. 1082) No details provided. (inherited from Presentation)
Callback <OnUpdate> (p. 1083) No details provided. (inherited from Presentation)
Attribute allowHighlight= (p. 1084) No details provided. (inherited from Presentation)
Attribute userObject= (p. 1085) No details provided. (inherited from Presentation)
Attribute visibility= (p. 1086) No details provided. (inherited from Presentation)
<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script. (inherited from
Presentation)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1077
ACT XML Tags
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<OnAdd>
No details provided. (inherited from Presentation)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IPresentation_
Name
OnAdd
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1078 of ANSYS, Inc. and its subsidiaries and affiliates.
<Scene>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDelete>
No details provided. (inherited from Presentation)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1079
ACT XML Tags
Details
CallbackType
ActionCallback_IPresentation_
Name
OnDelete
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHighlight>
No details provided. (inherited from Presentation)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1080 of ANSYS, Inc. and its subsidiaries and affiliates.
<Scene>
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IPresentation_
Name
OnHighlight
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1081
ACT XML Tags
<OnUnhighlight>
No details provided. (inherited from Presentation)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IPresentation_
Name
OnUnhighlight
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1082 of ANSYS, Inc. and its subsidiaries and affiliates.
<Scene>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUpdate>
No details provided. (inherited from Presentation)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IPresentation_
Name
OnUpdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1083
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
allowHighlight=
No details provided. (inherited from Presentation)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
allowHighlight
DefaultValue
True
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1084 of ANSYS, Inc. and its subsidiaries and affiliates.
<Scene>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
userObject=
No details provided. (inherited from Presentation)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
userObject
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1085
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
visibility=
No details provided. (inherited from Presentation)
Type
Ansys_ACT_Interfaces_Presentations_VisibilityOptions
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
visibility
DefaultValue
Always
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1086 of ANSYS, Inc. and its subsidiaries and affiliates.
<script>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<script>
Specifies the IronPython script referenced by the extension.
Remarks
None.
Examples
None.
Attribute compiled= (p. 1087) Specifies whether the script will be compiled as a
binary file.
Attribute context= (p. 1089) No details provided.
Attribute src= (p. 1090) Name of the Python script file.
compiled=
Specifies whether the script will be compiled as a binary file.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1087
ACT XML Tags
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
compiled
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1088 of ANSYS, Inc. and its subsidiaries and affiliates.
<script>
context=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
MultipleValue
False
Name
context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1089
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
MultipleValue
False
Name
src
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1090 of ANSYS, Inc. and its subsidiaries and affiliates.
<simdata>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<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.
<Load>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Load (p. 410)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1091
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Load
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Udf>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Udf (p. 1314)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1092 of ANSYS, Inc. and its subsidiaries and affiliates.
<simdata>
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Udf
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
context=
Context or combination of contexts (separated using '|').
Type
System_String_ARRAY_
Remarks
This block will be taken into account only for the specified context(s).
Examples
None.
Details
Mandatory
True
MultipleValue
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1093
ACT XML Tags
Name
context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Solver>
Class specifying a third-party solver to be used in the simulation.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1094 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1095
ACT XML Tags
Callback <OnReady> (p. 1122) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited
from SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 1124) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 1125) Callback that is invoked when the object is
shown. (inherited from SimEntity)
Callback <OnSolve> (p. 1126) Callback that is invoked when the solve process
is run.
Callback <OnSuppress> (p. 1127) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 1128) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Callback <OnWriteInputFile> (p. 1129) Callback that is invoked to write the solver input
file.
Tag <Property> (p. 1130) No details provided. (inherited from SimEntity)
Attribute analysis= (p. 1131) Type of analysis.
Attribute BeginGroup= (p. 1132) Indicates whether the load object will have a
separator before it when shown in the context
menu. (inherited from SimEntity)
Attribute caption= (p. 1133) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 1135) Class name of the controller of the object.
(inherited from SimEntity)
Attribute ContextGroup= (p. 1136) Indicates which group the load will be shown in
the context menu. (inherited from SimEntity)
Attribute contextual= (p. 1137) Indicates whether the object has to be displayed
in the contextual menu. (inherited from
SimEntity)
Attribute evaluateFunctionLoads= (p. 1138) Name of the toolbox.
Attribute icon= (p. 1139) Icon for the object. (inherited from SimEntity)
Attribute LazyActivateSelectProperties= (p. 1140) Determines when onActivate callback is called
for the properties. (inherited from SimEntity)
Attribute localize= (p. 1141) Indicates whether the caption and value string
need to be localized by the application.
(inherited from SimEntity)
Attribute name= (p. 1142) Name of the object. (inherited from SimEntity)
Attribute physics= (p. 1143) Type of physics.
Attribute toolbox= (p. 1144) Name of the toolbox.
Attribute version= (p. 1145) Version of the object. (inherited from SimEntity)
<AreMaterialPropertiesComplete>
Callback that is invoked to determine whether the materials properties are complete.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1096 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_AreMaterialPropertiesComplete
Name
AreMaterialPropertiesComplete
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1097
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Attributes>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1098 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1099
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1100 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Name
CanCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1101
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1102 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1103
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetFiles>
Callback that is invoked to return a list of file strings used by a custom solver.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetFiles
Name
GetFiles
Public
False
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1104 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<GetReader>
Callback that is invoked to get the reader class name and associated options.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetReader
Name
GetReader
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1105
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<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
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1106 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Details
CallbackType
Ansys_ACT_Core_Callbacks_GetSteps
Name
GetSteps
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<IsAnalysisValid>
Callback that is invoked to determine whether the analysis is valid.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1107
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsSolverAnalysisValid
Name
IsAnalysisValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1108 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1109
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1110 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1111
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBeforeSolve>
Callback that is invoked before the solve process.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBeforeSolve
Name
OnBeforeSolve
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1112 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1113
ACT XML Tags
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnCheckResults>
Callback that is invoked before any post-processing evaluation.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1114 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnCheckResults
Name
OnCheckResults
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1115
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1116 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1117
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1118 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnHide
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1119
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnInit
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1120 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
It enables the migration of data from the old saved object to the new one.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1121
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1122 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1123
ACT XML Tags
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1124 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1125
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSolve>
Callback that is invoked when the solve process is run.
Type
Ansys_ACT_Core_XmlDataModel_CallbackOnSolve (p. 83)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSolve
Name
OnSolve
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1126 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnSuppress
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1127
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1128 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnWriteInputFile>
Callback that is invoked to write the solver input file.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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".
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1129
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnWriteInputFile
Name
OnWriteInputFile
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1130 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
analysis=
Type of analysis.
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1131
ACT XML Tags
Examples
None.
Details
Name
analysis
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Type
System_Boolean
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1132 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Remarks
None.
Examples
None.
Details
Name
BeginGroup
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the object. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1133
ACT XML Tags
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1134 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
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:
Examples
None.
Details
Name
class
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1135
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
ContextGroup
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1136 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Name
contextual
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1137
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
evaluateFunctionLoads=
Name of the toolbox.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
evaluateFunctionLoads
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1138 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
icon
Mandatory
False
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1139
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
LazyActivateSelectProperties
Mandatory
False
DefaultValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1140 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
localize
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1141
ACT XML Tags
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1142 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Details
Name
name
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
physics=
Type of physics.
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1143
ACT XML Tags
Examples
None.
Details
Name
physics
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
toolbox=
Name of the toolbox.
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1144 of ANSYS, Inc. and its subsidiaries and affiliates.
<Solver>
Remarks
None.
Examples
None.
Details
Name
toolbox
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Version of the object. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1145
ACT XML Tags
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
version
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1146 of ANSYS, Inc. and its subsidiaries and affiliates.
<StandardAction>
<StandardAction>
No details provided.
Remarks
None.
Examples
None.
actionId=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
actionId
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1147
ACT XML Tags
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1148 of ANSYS, Inc. and its subsidiaries and affiliates.
<StandardAction>
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1149
ACT XML Tags
Description
None.
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Step>
Class defining a step in a guided process a (wizard or AIM custom template).
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1150 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
Callback <CanAdd> (p. 1154) Callback that is invoked to determine whether the
object can be added. (inherited from SimEntity)
Callback <CanCreate> (p. 1155) Callback that is invoked to determine whether the
object can be created via the Object Creation API.
(inherited from SimEntity)
Callback <CanDuplicate> (p. 1156) Callback that is invoked to determine if the object
can be duplicated. (inherited from SimEntity)
Callback <CanRemove> (p. 1157) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Tag <ComponentData> (p. 1159) Data of the components in the step's layout.
Tag <ComponentStyle> (p. 1159) Styles of the components in the step's layout.
Tag <Description> (p. 1160) Gets or sets the description of the step.
Callback <IsValid> (p. 1161) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 1162) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 1163) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 1164)Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 1166) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <oncreate> (p. 1167) No details provided.
Callback <OnDuplicate> (p. 1168) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 1169) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 1170) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 1171) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 1173) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 1174) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <onrefresh> (p. 1175) Callback that is invoked when the step is
initialized.
Callback <OnRemove> (p. 1176) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <onreset> (p. 1177) Callback that is invoked when we return to the
previous step.
Callback <OnShow> (p. 1178) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1151
ACT XML Tags
Callback <OnSuppress> (p. 1180) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 1181) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Callback <onupdate> (p. 1182) Callback that is invoked when the step is finalized.
Tag <Property> (p. 1183) No details provided. (inherited from SimEntity)
Attribute BeginGroup= (p. 1184) Indicates whether the load object will have a
separator before it when shown in the context
menu. (inherited from SimEntity)
Attribute caption= (p. 1185) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 1186) Class name of the controller of the object.
(inherited from SimEntity)
Attribute Context= (p. 1187) Gets or sets the context name.
Attribute ContextGroup= (p. 1188) Indicates which group the load will be shown in
the context menu. (inherited from SimEntity)
Attribute contextual= (p. 1189) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute Enabled= (p. 1190) Gets or sets the Enabled flag.
Attribute helpFile= (p. 1191) File containing help HTML content.
Attribute icon= (p. 1193) Icon for the object. (inherited from SimEntity)
Attribute Layout= (p. 1194) Gets or sets the layout to use for this step.
Attribute LazyActivateSelectProperties= (p. 1195) Determines when onActivate callback is called for
the properties. (inherited from SimEntity)
Attribute localize= (p. 1196) Indicates whether the caption and value string
need to be localized by the application. (inherited
from SimEntity)
Attribute name= (p. 1197) Name of the object. (inherited from SimEntity)
Attribute version= (p. 1198) Version of the object. (inherited from SimEntity)
<Attributes>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1152 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1153
ACT XML Tags
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1154 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Name
CanCreate
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1155
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1156 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1157
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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1158 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
<ComponentData>
Data of the components in the step's layout.
Type
Ansys_ACT_Core_XmlDataModel_ComponentData (p. 113)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<ComponentStyle>
Styles of the components in the step's layout.
Type
Ansys_ACT_Core_XmlDataModel_ComponentStyle (p. 123)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1159
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Description>
Gets or sets the description of the step.
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1160 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
Details
Description
None.
Name
Description
ValueName
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1161
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is not invoked when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1162 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1163
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1164 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1165
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1166 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<oncreate>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IWizardStep_
Name
oncreate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1167
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnDuplicate
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1168 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnGenerateData
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1169
ACT XML Tags
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1170 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1171
ACT XML Tags
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1172 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1173
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1174 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onrefresh>
Callback that is invoked when the step is initialized.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IWizardStep_
Name
onrefresh
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1175
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnRemove
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1176 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onreset>
Callback that is invoked when we return to the previous step.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1177
ACT XML Tags
Details
CallbackType
ActionCallback_IWizardStep_
Name
onreset
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1178 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1179
ACT XML Tags
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1180 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1181
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onupdate>
Callback that is invoked when the step is finalized.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IWizardStep_
Name
onupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1182 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1183
ACT XML Tags
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
BeginGroup
DefaultValue
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1184 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
caption
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1185
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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:
Examples
None.
Details
Mandatory
False
Name
class
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1186 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Context=
Gets or sets the context name.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1187
ACT XML Tags
Name
Context
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1188 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
Details
Mandatory
False
Name
ContextGroup
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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".
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1189
ACT XML Tags
Examples
None.
Details
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Enabled=
Gets or sets the Enabled flag.
Type
System_Boolean
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1190 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
Remarks
This flag is true by default.
Examples
None.
Details
Mandatory
False
Name
Enabled
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
helpFile=
File containing help HTML content.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1191
ACT XML Tags
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
helpFile
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1192 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
icon=
Icon for the object. (inherited from SimEntity)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1193
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1194 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
LazyActivateSelectProperties
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1195
ACT XML Tags
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
localize
DefaultValue
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1196 of ANSYS, Inc. and its subsidiaries and affiliates.
<Step>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1197
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Version of the object. (inherited from SimEntity)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
version
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1198 of ANSYS, Inc. and its subsidiaries and affiliates.
<Target>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Target>
Class defining the target location for the object.
Remarks
None.
Examples
None.
location=
Sub-type of the target location when ype==Analysis.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1199
ACT XML Tags
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
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1200 of ANSYS, Inc. and its subsidiaries and affiliates.
<Target>
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1201
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1202 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<task>
Class defining a task that encapsulates a single process or application.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1203
ACT XML Tags
Callback <OnClearData> (p. 1220) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <ondelete> (p. 1221) Callback that is invoked for task deletion.
Callback <OnDuplicate> (p. 1222) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <onedit> (p. 1223) Callback that is invoked for task EDIT entry.
Callback <OnGenerateData> (p. 1224) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 1226) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 1227) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <oninitialize> (p. 1228) Callback that is invoked for task creation.
Callback <onload> (p. 1229) Callback that is invoked when a task is loaded
from disk.
Callback <OnMigrate> (p. 1230) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 1231) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <onrefresh> (p. 1233) Callback that is invoked for task refresh.
Callback <OnRemove> (p. 1234) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <onreport> (p. 1235) Callback that is invoked for task reporting.
Callback <onreset> (p. 1236) Callback that is invoked for task reset.
Callback <OnShow> (p. 1237) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <onstatus> (p. 1238) Callback that is invoked for task status.
Callback <OnSuppress> (p. 1239) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 1241) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Callback <onupdate> (p. 1242) Callback that is invoked for task update.
Tag <Outputs> (p. 1243) User-defined task output connections.
Tag <Parameters> (p. 1244) User-defined parameters to be exposed on the
task.
Tag <Property> (p. 1245) No details provided. (inherited from SimEntity)
Tag <RsmJob> (p. 1245) List of task-level RSM Jobs.
Attribute BeginGroup= (p. 1246) Indicates whether the load object will have a
separator before it when shown in the context
menu. (inherited from SimEntity)
Attribute caption= (p. 1247) Caption of the object. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1204 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Attribute class= (p. 1248) Class name of the controller of the object.
(inherited from SimEntity)
Attribute ContextGroup= (p. 1250) Indicates which group the load will be shown in
the context menu. (inherited from SimEntity)
Attribute contextual= (p. 1251) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute editicon= (p. 1252) Name of the icon to display when an onedit
callback is defined.
Attribute enableGenericTransfer= (p. 1253) Indicates whether or not the task should expose
the general transfer type as an output.
Attribute icon= (p. 1254) Icon for the object. (inherited from SimEntity)
Attribute LazyActivateSelectProperties= (p. 1255) Determines when onActivate callback is called for
the properties. (inherited from SimEntity)
Attribute localize= (p. 1256) Indicates whether the caption and value string
need to be localized by the application. (inherited
from SimEntity)
Attribute name= (p. 1257) Name of the object. (inherited from SimEntity)
Attribute version= (p. 1258) Version of the object. (inherited from SimEntity)
<Attributes>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1205
ACT XML Tags
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1206 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1207
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<canconsumedata>
Callback that is invoked for task connection/consumption.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_object__IUserObject__bool_
Name
canconsumedata
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1208 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Name
CanCreate
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1209
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1210 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1211
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<ContextMenus>
The user-defined custom context menu entries.
Type
Ansys_ACT_Core_XmlDataModel_ContextMenus (p. 128)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1212 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_ContextMenus
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Inputs>
User-defined task input connections.
Type
Ansys_ACT_Core_XmlDataModel_Inputs (p. 351)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1213
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Inputs
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1214 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is not invoked when the project is reopened.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1215
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1216 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1217
ACT XML Tags
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1218 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onclean>
Callback that is invoked for task cleaning.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onclean
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1219
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1220 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<ondelete>
Callback that is invoked for task deletion.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
ondelete
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1221
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1222 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onedit>
Callback that is invoked for task EDIT entry.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1223
ACT XML Tags
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onedit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1224 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1225
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1226 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1227
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<oninitialize>
Callback that is invoked for task creation.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
oninitialize
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1228 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onload>
Callback that is invoked when a task is loaded from disk.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onload
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1229
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
It enables the migration of data from the old saved object to the new one.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1230 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1231
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1232 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
<onrefresh>
Callback that is invoked for task refresh.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onrefresh
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1233
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1234 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onreport>
Callback that is invoked for task reporting.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__object_
Name
onreport
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1235
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onreset>
Callback that is invoked for task reset.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onreset
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1236 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1237
ACT XML Tags
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onstatus>
Callback that is invoked for task status.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1238 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__object_
Name
onstatus
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1239
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1240 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1241
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onupdate>
Callback that is invoked for task update.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1242 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Outputs>
User-defined task output connections.
Type
Ansys_ACT_Core_XmlDataModel_Outputs (p. 669)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Outputs
MinOccurence
MaxOccurence
-1
RealParent
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1243
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Parameters>
User-defined parameters to be exposed on the task.
Type
Ansys_ACT_Core_XmlDataModel_Parameters (p. 746)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Parameters
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1244 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
<Property>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<RsmJob>
List of task-level RSM Jobs.
Type
Ansys_ACT_Core_XmlDataModel_RsmJob (p. 975)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1245
ACT XML Tags
Remarks
Currently only one entry is allowed.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_RsmJob
MinOccurence
MaxOccurence
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1246 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Details
Mandatory
False
DefaultValue
False
Name
BeginGroup
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1247
ACT XML Tags
Examples
None.
Details
Mandatory
False
DefaultValue
None.
Name
caption
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
class=
Class name of the controller of the object. (inherited from SimEntity)
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1248 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Remarks
The constructor of the class referenced by this attribute takes two arguments:
Examples
None.
Details
Mandatory
False
DefaultValue
None.
Name
class
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1249
ACT XML Tags
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
DefaultValue
None.
Name
ContextGroup
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1250 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Mandatory
False
DefaultValue
True
Name
contextual
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1251
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
editicon=
Name of the icon to display when an onedit callback is defined.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
DefaultValue
None.
Name
editicon
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1252 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1253
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
DefaultValue
None.
Name
icon
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1254 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
DefaultValue
False
Name
LazyActivateSelectProperties
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1255
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
DefaultValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1256 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Name
localize
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1257
ACT XML Tags
DefaultValue
None.
Name
name
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Version of the object. (inherited from SimEntity)
Type
System_Int32
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1258 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
Details
Mandatory
True
DefaultValue
None.
Name
version
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<task>
No details provided.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1259
ACT XML Tags
Examples
None.
Message=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
Message
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1260 of ANSYS, Inc. and its subsidiaries and affiliates.
<task>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Name=
No details provided.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
Name
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1261
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Pct=
No details provided.
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
Pct
DefaultValue
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1262 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<taskgroup>
Class defining a collection of tasks.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1263
ACT XML Tags
Callback <CanRemove> (p. 1270) Callback that is invoked to determine if the object
can be removed. (inherited from SimEntity)
Tag <IncludeGroup> (p. 1271) The task group's List of nested task groups.
Tag <IncludeTask> (p. 1272) List of tasks for the task group.
Callback <IsValid> (p. 1273) Callback that is invoked to determine if the object
is valid. (inherited from SimEntity)
Callback <OnAdd> (p. 1274) Callback that is invoked when the object is newly
added. (inherited from SimEntity)
Callback <OnAfterGeometryUpdate> (p. 1275) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 1276)Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 1277) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 1279) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 1280) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 1281) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 1282) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 1283) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 1284) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 1286) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 1287) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 1288) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 1289) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 1290) No details provided. (inherited from SimEntity)
Attribute abbreviation= (p. 1291) Task group abbreviation used for directory and
naming purposes.
Attribute BeginGroup= (p. 1292) Indicates whether the load object will have a
separator before it when shown in the context
menu. (inherited from SimEntity)
Attribute caption= (p. 1293) Caption of the object. (inherited from SimEntity)
Attribute category= (p. 1294) Category to which the task group applies.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1264 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
Attribute class= (p. 1295) Class name of the controller of the object.
(inherited from SimEntity)
Attribute ContextGroup= (p. 1296) Indicates which group the load will be shown in
the context menu. (inherited from SimEntity)
Attribute contextual= (p. 1298) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute headertext= (p. 1299) The text to display in the both the toolbox and
the task group header block.
Attribute icon= (p. 1300) Icon for the object. (inherited from SimEntity)
Attribute isparametricgroup= (p. 1301) Indicates whether the taskgroup operates only on
parameters.
Attribute LazyActivateSelectProperties= (p. 1302) Determines when onActivate callback is called for
the properties. (inherited from SimEntity)
Attribute localize= (p. 1303) Indicates whether the caption and value string
need to be localized by the application. (inherited
from SimEntity)
Attribute name= (p. 1304) Name of the object. (inherited from SimEntity)
Attribute version= (p. 1305) Version of the object. (inherited from SimEntity)
<Attributes>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1265
ACT XML Tags
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1266 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1267
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Name
CanCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1268 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1269
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Name
CanRemove
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1270 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<IncludeGroup>
The task group's List of nested task groups.
Type
Ansys_ACT_Core_XmlDataModel_IncludeGroup (p. 330)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1271
ACT XML Tags
Details
ChildType
Ansys_ACT_Core_XmlDataModel_IncludeGroup
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<IncludeTask>
List of tasks for the task group.
Type
Ansys_ACT_Core_XmlDataModel_IncludeTask (p. 334)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_IncludeTask
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1272 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1273
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is not invoked when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnAdd
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1274 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1275
ACT XML Tags
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1276 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1277
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1278 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1279
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1280 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnHide
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1281
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnInit
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1282 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
It enables the migration of data from the old saved object to the new one.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1283
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnEntityMigrate
Name
OnMigrate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1284 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1285
ACT XML Tags
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1286 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1287
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1288 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnUnsuppress
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1289
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1290 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
abbreviation=
Task group abbreviation used for directory and naming purposes.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
abbreviation
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1291
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
BeginGroup
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1292 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1293
ACT XML Tags
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
category=
Category to which the task group applies.
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1294 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
Details
Mandatory
False
Name
category
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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:
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1295
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1296 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
ContextGroup
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1297
ACT XML Tags
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
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1298 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1299
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1300 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1301
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
LazyActivateSelectProperties
DefaultValue
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1302 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
localize
DefaultValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1303
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
name
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1304 of ANSYS, Inc. and its subsidiaries and affiliates.
<taskgroup>
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Version of the object. (inherited from SimEntity)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Mandatory
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1305
ACT XML Tags
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<taskgroups>
Class defining the task groups collection.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1306 of ANSYS, Inc. and its subsidiaries and affiliates.
<tasks>
<TaskGroup>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_TaskGroup (p. 1263)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_TaskGroup
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<tasks>
Class defining the tasks collection.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1307
ACT XML Tags
Examples
None.
<Task>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Task (p. 1203)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Task
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1308 of ANSYS, Inc. and its subsidiaries and affiliates.
<Templates>
<Templates>
Class defining a collection of control templates.
Remarks
None.
Examples
None.
Tag <ControlTemplate> (p. 1309) 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. 129)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1309
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<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.
<Separator>
Separator for the toolbar.
Type
Ansys_ACT_Core_XmlDataModel_Separator (p. 1091)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1310 of ANSYS, Inc. and its subsidiaries and affiliates.
<toolbar>
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Separator
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
caption=
Caption of the toolbar.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1311
ACT XML Tags
MultipleValue
False
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application.
Type
System_Boolean
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1312 of ANSYS, Inc. and its subsidiaries and affiliates.
<toolbar>
Details
Mandatory
False
MultipleValue
False
Name
localize
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the toolbar.
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1313
ACT XML Tags
Examples
None.
Details
Mandatory
True
MultipleValue
False
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<udf>
Specifies the UDF folder referenced by the extension.
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1314 of ANSYS, Inc. and its subsidiaries and affiliates.
<udf>
Examples
None.
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
Mandatory
False
Name
folder
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1315
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<UIDefinition>
Class defining a set of interface layouts that can be used for guided processes (wizards).
Remarks
None.
Examples
None.
<ComponentDefinition>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_UI_ComponentDefinition (p. 115)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1316 of ANSYS, Inc. and its subsidiaries and affiliates.
<UIDefinition>
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Layout>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_UI_Layout (p. 398)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1317
ACT XML Tags
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<UserDefinedTask>
Class defining a new application task.
Remarks
None.
Examples
None.
<Callbacks>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1318 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserDefinedTask>
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<onUpdate>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_string_
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1319
ACT XML Tags
Name
onUpdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
caption=
The caption of the task. (inherited from BaseTaskTag)
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1320 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserDefinedTask>
Examples
None.
Details
Mandatory
False
Description
None.
Name
caption
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
The name of the task. (inherited from BaseTaskTag)
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1321
ACT XML Tags
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<UserInputTask>
Class defining a new user input application task.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1322 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserInputTask>
Remarks
None.
Examples
None.
<DataModelInOut>
The panel associated to the task.
Type
Ansys_ACT_Core_XmlDataModel_Application_DataModelInOut (p. 132)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_DataModelInOut
MinOccurence
MaxOccurence
-1
RealParent
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1323
ACT XML Tags
Mandatory
True
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
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
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1324 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserInputTask>
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1325
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
panel=
The panel associated to the task.
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
True
Description
None.
Name
panel
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1326 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<UserObject>
Class defining a user object of the data model.
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1327
ACT XML Tags
Callback <OnAfterGeometryUpdate> (p. 1337) Callback that is invoked when the geometry has
been updated. (inherited from SimEntity)
Callback <OnBodySuppressStateChange> (p. 1339)Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 1340) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 1341) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 1342) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 1343) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 1344) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 1345) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Callback <OnReady> (p. 1347) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 1348) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 1349) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 1350) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 1351) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 1352) No details provided. (inherited from SimEntity)
Attribute basedonxmldefinition= (p. 1353) Indicates if the definition of the UserObject is
strictly defined by its xml definition.
Attribute BeginGroup= (p. 1354) Indicates whether the load object will have a
separator before it when shown in the context
menu. (inherited from SimEntity)
Attribute caption= (p. 1355) Caption of the object. (inherited from SimEntity)
Attribute cardinality= (p. 1357) Cardinality of the user object regarding is parent.
Attribute class= (p. 1358) Class name of the controller of the object.
(inherited from SimEntity)
Attribute ContextGroup= (p. 1359) Indicates which group the load will be shown in
the context menu. (inherited from SimEntity)
Attribute contextual= (p. 1360) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute icon= (p. 1361) Icon for the object. (inherited from SimEntity)
Attribute LazyActivateSelectProperties= (p. 1362) Determines when onActivate callback is called for
the properties. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1328 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
Attribute localize= (p. 1363) Indicates whether the caption and value string
need to be localized by the application. (inherited
from SimEntity)
Attribute name= (p. 1364) Name of the object. (inherited from SimEntity)
Attribute parent= (p. 1365) Name of the parent user object.
Attribute version= (p. 1366) Version of the object. (inherited from SimEntity)
<Attributes>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1329
ACT XML Tags
<Callbacks>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1330 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Name
CanAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1331
ACT XML Tags
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Name
CanCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1332 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1333
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Name
CanRemove
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1334 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1335
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is not invoked when the project is reopened.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1336 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnAdd
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1337
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1338 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1339
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnClearData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1340 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1341
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnGenerateData
Public
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1342 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1343
ACT XML Tags
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1344 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1345
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1346 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1347
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1348 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnShow
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1349
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1350 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1351
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1352 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
basedonxmldefinition=
Indicates if the definition of the UserObject is strictly defined by its xml definition.
Type
System_Boolean
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1353
ACT XML Tags
Examples
None.
Details
Mandatory
False
Name
basedonxmldefinition
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Type
System_Boolean
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1354 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
BeginGroup
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the object. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1355
ACT XML Tags
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1356 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
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
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1357
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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:
Examples
None.
Details
Mandatory
False
Name
class
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1358 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
ContextGroup
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1359
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Mandatory
False
Name
contextual
DefaultValue
True
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1360 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
icon
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1361
ACT XML Tags
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
LazyActivateSelectProperties
DefaultValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1362 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1363
ACT XML Tags
Name
localize
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1364 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObject>
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
parent=
Name of the parent user object.
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1365
ACT XML Tags
Examples
None.
Details
Mandatory
False
Name
parent
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Version of the object. (inherited from SimEntity)
Type
System_Int32
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1366 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObjectConverter>
Remarks
None.
Examples
None.
Details
Mandatory
True
Name
version
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<UserObjectConverter>
No details provided.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1367
ACT XML Tags
Remarks
None.
Examples
None.
<Callbacks>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1368 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObjectConverter>
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<OnReadInput>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__StreamReader_
Name
OnReadInput
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1369
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSendBackData>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__IExtAPI_
Name
OnSendBackData
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1370 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObjectConverter>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSendData>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__IExtAPI_
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1371
ACT XML Tags
Name
OnSendData
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnWriteInput>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1372 of ANSYS, Inc. and its subsidiaries and affiliates.
<UserObjectConverter>
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__StreamWriter_
Name
OnWriteInput
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
userObject=
No details provided.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1373
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1374 of ANSYS, Inc. and its subsidiaries and affiliates.
<Wizard>
<Wizard>
Class defining a guided process (a wizard or AIM custom template) within the extension.
Remarks
None.
Examples
None.
Tag <Callbacks> (p. 1375) Specifies the callbacks that will invoke functions from the
IronPython extension script. (inherited from BaseApplication)
Callback <canstart> (p. 1376) Callback that is invoked to determine whether the application
can be started. (inherited from BaseApplication)
Tag <Description> (p. 1377) Description of the application. (inherited from BaseApplication)
Tag <Step> (p. 1378) No details provided.
Attribute allowNavigation= (p. 1379) No details provided.
Attribute caption= (p. 1380) Caption of the application. (inherited from BaseApplication)
Attribute context= (p. 1381) Context or combination of contexts (separated using '|').
(inherited from BaseApplication)
Attribute hidden= (p. 1382) No details provided.
Attribute icon= (p. 1383) Icon for the application. (inherited from BaseApplication)
Attribute layout= (p. 1384) Layout to be used to display the wizard.
Attribute name= (p. 1385) Name of the application. (inherited from BaseApplication)
Attribute persistent= (p. 1386) No details provided.
Attribute subContext= (p. 1387) Sub-context used by AIM to filter the availability of the wizard.
Attribute version= (p. 1389) Major version of the application. (inherited from BaseApplication)
<Callbacks>
Specifies the callbacks that will invoke functions from the IronPython extension script. (inherited from
BaseApplication)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1375
ACT XML Tags
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<canstart>
Callback that is invoked to determine whether the application can be started. (inherited from Base-
Application)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_string__bool_
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1376 of ANSYS, Inc. and its subsidiaries and affiliates.
<Wizard>
Name
canstart
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Description>
Description of the application. (inherited from BaseApplication)
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1377
ACT XML Tags
Examples
None.
Details
Description
ValueName
description
Name
Description
Public
True
TypeId
Ansys_ACT_Core_Attributes_XmlTagAttribute
<Step>
No details provided.
Type
Ansys_ACT_Core_XmlDataModel_Step (p. 1150)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Step
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1378 of ANSYS, Inc. and its subsidiaries and affiliates.
<Wizard>
MaxOccurence
-1
RealParent
None.
Mandatory
True
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
allowNavigation=
No details provided.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
allowNavigation
DefaultValue
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1379
ACT XML Tags
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the application. (inherited from BaseApplication)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
caption
Mandatory
False
DefaultValue
None.
DataDefinition
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1380 of ANSYS, Inc. and its subsidiaries and affiliates.
<Wizard>
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1381
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
hidden=
No details provided.
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
hidden
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1382 of ANSYS, Inc. and its subsidiaries and affiliates.
<Wizard>
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
False
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the application. (inherited from BaseApplication)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
icon
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1383
ACT XML Tags
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
layout=
Layout to be used to display the wizard.
Type
System_String
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1384 of ANSYS, Inc. and its subsidiaries and affiliates.
<Wizard>
Details
Mandatory
False
Name
layout
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the application. (inherited from BaseApplication)
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1385
ACT XML Tags
Examples
None.
Details
Mandatory
True
Name
name
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
persistent=
No details provided.
Type
System_Boolean
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1386 of ANSYS, Inc. and its subsidiaries and affiliates.
<Wizard>
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
persistent
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
subContext=
Sub-context used by AIM to filter the availability of the wizard.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1387
ACT XML Tags
Type
System_String
Remarks
None.
Examples
None.
Details
Mandatory
False
Name
subContext
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1388 of ANSYS, Inc. and its subsidiaries and affiliates.
<Wizard>
version=
Major version of the application. (inherited from BaseApplication)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
version
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1389
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Workflow>
Class defining the top-level workflow tag within an ACT app.
Remarks
Used to define process integration items (tasks and task groups)
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1390 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Callback <onaftertaskpropertyretrieval> (p. 1409) CCallback that is invoked after a task provides its
property-containing objects.
Callback <onaftertaskrefresh> (p. 1410) Callback that is invoked after a task has been
refreshed.
Callback <onaftertaskreset> (p. 1411) Callback that is invoked after a task has been reset.
Callback <onaftertasksourceschanged> (p. 1413) Callback that is invoked after a task handles a
source change.
Callback <onaftertaskstatus> (p. 1414) Callback that is invoked after a task determines
its status.
Callback <onaftertaskupdate> (p. 1415) Callback that is invoked after a task has been
updated.
Callback <onbeforedesignpointchanged> (p. 1416)Callback that is invoked immediately before the
design point changes.
Callback <onbeforetaskcanduplicate> (p. 1417) Callback that is invoked before a task determines
duplication viability.
Callback <onbeforetaskcanusetransfer> (p. 1418) Callback that is invoked before a task determines
transfer data viability.
Callback <onbeforetaskcreation> (p. 1419) Callback that is invoked before a task is created.
Callback <onbeforetaskdeletion> (p. 1421) Callback that is invoked before a task is deleted.
Callback <onbeforetaskduplicate> (p. 1422) Callback that is invoked before a task is duplicated.
Callback <onbeforetaskpropertyretrieval> (p. 1423)Callback that is invoked before a task provides its
property-containing objects.
Callback <onbeforetaskrefresh> (p. 1424) Callback that is invoked before a task is refreshed.
Callback <onbeforetaskreset> (p. 1425) Callback that is invoked before a task is reset.
Callback <onbeforetasksourceschanged> (p. 1426)Callback that is invoked before a task handles a
source change.
Callback <onbeforetaskstatus> (p. 1428) Callback that is invoked before a task determines
its status.
Callback <onbeforetaskupdate> (p. 1429) Callback that is invoked before a task is updated.
Callback <OnBodySuppressStateChange> (p. 1430)Callback that is invoked when the body suppress
state changse. (inherited from SimEntity)
Callback <OnClearData> (p. 1431) Callback that is invoked when object data are
cleared. (inherited from SimEntity)
Callback <OnDuplicate> (p. 1432) Callback that is invoked when the object is
duplicated. (inherited from SimEntity)
Callback <OnGenerateData> (p. 1433) Callback that is invoked when object data are
generated. (inherited from SimEntity)
Callback <OnHide> (p. 1434) Callback that is invoked when the object is hidden.
(inherited from SimEntity)
Callback <OnInit> (p. 1436) Callback that is invoked when the object is
initialized. (inherited from SimEntity)
Callback <OnMigrate> (p. 1437) Callback that is invoked when the object version
has been changed. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1391
ACT XML Tags
Callback <OnReady> (p. 1438) Callback that is invoked when the application is
fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Callback <OnRemove> (p. 1439) Callback that is invoked when the object is
removed. (inherited from SimEntity)
Callback <OnShow> (p. 1440) Callback that is invoked when the object is shown.
(inherited from SimEntity)
Callback <OnSuppress> (p. 1441) Callback that is invoked when the object is
suppressed. (inherited from SimEntity)
Callback <OnUnsuppress> (p. 1443) Callback that is invoked when the object is
unsuppressed. (inherited from SimEntity)
Tag <Property> (p. 1444) No details provided. (inherited from SimEntity)
Tag <TaskGroups> (p. 1445) Task groupings to be exposed as organized blocks
within the workflow.
Tag <Tasks> (p. 1445) Tasks xposed by this workflow.
Attribute BeginGroup= (p. 1446) Indicates whether the load object will have a
separator before it when shown in the context
menu. (inherited from SimEntity)
Attribute caption= (p. 1447) Caption of the object. (inherited from SimEntity)
Attribute class= (p. 1448) Class name of the controller of the object.
(inherited from SimEntity)
Attribute context= (p. 1450) Contexts (application) to which this workflow
applies.
Attribute ContextGroup= (p. 1451) Indicates which group the load will be shown in
the context menu. (inherited from SimEntity)
Attribute contextual= (p. 1452) Indicates whether the object has to be displayed
in the contextual menu. (inherited from SimEntity)
Attribute icon= (p. 1453) Icon for the object. (inherited from SimEntity)
Attribute LazyActivateSelectProperties= (p. 1454) Determines when onActivate callback is called for
the properties. (inherited from SimEntity)
Attribute localize= (p. 1455) Indicates whether the caption and value string
need to be localized by the application. (inherited
from SimEntity)
Attribute name= (p. 1456) Name of the object. (inherited from SimEntity)
Attribute version= (p. 1457) Version of the object. (inherited from SimEntity)
<Attributes>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Attributes (p. 56)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1392 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Remarks
None.
Examples
None.
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Callbacks>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callbacks (p. 86)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1393
ACT XML Tags
Details
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<CanAdd>
Callback that is invoked to determine whether the object can be added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanAdd
Name
CanAdd
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1394 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanCreate>
Callback that is invoked to determine whether the object can be created via the Object Creation API.
(inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1395
ACT XML Tags
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanCreate
Name
CanCreate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<CanDuplicate>
Callback that is invoked to determine if the object can be duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1396 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanDuplicate
Name
CanDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1397
ACT XML Tags
<CanRemove>
Callback that is invoked to determine if the object can be removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_CanRemove
Name
CanRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1398 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<IsValid>
Callback that is invoked to determine if the object is valid. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_IsValidLocation
Name
IsValid
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1399
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAdd>
Callback that is invoked when the object is newly added. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1400 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onafterdesignpointchanged>
Callback that is invoked after the design point has changed.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
onafterdesignpointchanged
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1401
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnAfterGeometryUpdate>
Callback that is invoked when the geometry has been updated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1402 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Name
OnAfterGeometryUpdate
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onaftertaskcanduplicate>
Callback that is invoked after a task determines duplication viability.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1403
ACT XML Tags
Examples
None.
Details
CallbackType
FuncCallback_object__object_
Name
onaftertaskcanduplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onaftertaskcanusetransfer>
Callback that is invoked after a task determines transfer data viability.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1404 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__IUserObject__object__object_
Name
onaftertaskcanusetransfer
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1405
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onaftertaskcreation>
Callback that is invoked after a task has been created.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onaftertaskcreation
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1406 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onaftertaskdeletion>
Callback that is invoked after a task is deleted.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onaftertaskdeletion
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1407
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onaftertaskduplicate>
Callback that is invoked after a task has been duplicated.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onaftertaskduplicate
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1408 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onaftertaskpropertyretrieval>
CCallback that is invoked after a task provides its property-containing objects.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__object__object_
Name
onaftertaskpropertyretrieval
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1409
ACT XML Tags
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onaftertaskrefresh>
Callback that is invoked after a task has been refreshed.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1410 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Details
CallbackType
ActionCallback_IUserObject_
Name
onaftertaskrefresh
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onaftertaskreset>
Callback that is invoked after a task has been reset.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1411
ACT XML Tags
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onaftertaskreset
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1412 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
<onaftertasksourceschanged>
Callback that is invoked after a task handles a source change.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onaftertasksourceschanged
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1413
ACT XML Tags
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onaftertaskstatus>
Callback that is invoked after a task determines its status.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
FuncCallback_IUserObject__object__object_
Name
onaftertaskstatus
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1414 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onaftertaskupdate>
Callback that is invoked after a task has been updated.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onaftertaskupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1415
ACT XML Tags
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onbeforedesignpointchanged>
Callback that is invoked immediately before the design point changes.
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Name
onbeforedesignpointchanged
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1416 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onbeforetaskcanduplicate>
Callback that is invoked before a task determines duplication viability.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_ActionCallback
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1417
ACT XML Tags
Name
onbeforetaskcanduplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onbeforetaskcanusetransfer>
Callback that is invoked before a task determines transfer data viability.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1418 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Examples
None.
Details
CallbackType
ActionCallback_IUserObject__IUserObject_
Name
onbeforetaskcanusetransfer
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onbeforetaskcreation>
Callback that is invoked before a task is created.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1419
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onbeforetaskcreation
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1420 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onbeforetaskdeletion>
Callback that is invoked before a task is deleted.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onbeforetaskdeletion
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1421
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onbeforetaskduplicate>
Callback that is invoked before a task is duplicated.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onbeforetaskduplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1422 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onbeforetaskpropertyretrieval>
Callback that is invoked before a task provides its property-containing objects.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onbeforetaskpropertyretrieval
Public
True
Obsolete
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1423
ACT XML Tags
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onbeforetaskrefresh>
Callback that is invoked before a task is refreshed.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onbeforetaskrefresh
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1424 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onbeforetaskreset>
Callback that is invoked before a task is reset.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1425
ACT XML Tags
Details
CallbackType
ActionCallback_IUserObject_
Name
onbeforetaskreset
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onbeforetasksourceschanged>
Callback that is invoked before a task handles a source change.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1426 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onbeforetasksourceschanged
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1427
ACT XML Tags
<onbeforetaskstatus>
Callback that is invoked before a task determines its status.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onbeforetaskstatus
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1428 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<onbeforetaskupdate>
Callback that is invoked before a task is updated.
Type
Ansys_ACT_Core_XmlDataModel_OrderableCallback (p. 660)
Remarks
None.
Examples
None.
Details
CallbackType
ActionCallback_IUserObject_
Name
onbeforetaskupdate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1429
ACT XML Tags
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnBodySuppressStateChange>
Callback that is invoked when the body suppress state changse. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnBodySupressStateChange
Name
OnBodySuppressStateChange
Public
False
Obsolete
False
ObsoleteMessage
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1430 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnClearData>
Callback that is invoked when object data are cleared. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnClearData
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1431
ACT XML Tags
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnDuplicate>
Callback that is invoked when the object is duplicated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1432 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Name
OnDuplicate
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnGenerateData>
Callback that is invoked when object data are generated. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1433
ACT XML Tags
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnDataStateChanged
Name
OnGenerateData
Public
False
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnHide>
Callback that is invoked when the object is hidden. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1434 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnHide
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1435
ACT XML Tags
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnInit>
Callback that is invoked when the object is initialized. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
This callback is called after the OnAdd callback and when the project is reopened.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnInitEntity
Name
OnInit
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1436 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnMigrate>
Callback that is invoked when the object version has been changed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
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.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1437
ACT XML Tags
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnReady>
Callback that is invoked when the application is fully loaded and in a "ready" state. (Inherited from
SimEntity) (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnReady
Name
OnReady
Public
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1438 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnRemove>
Callback that is invoked when the object is removed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnAddRemove
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1439
ACT XML Tags
Name
OnRemove
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnShow>
Callback that is invoked when the object is shown. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1440 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnShowHide
Name
OnShow
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnSuppress>
Callback that is invoked when the object is suppressed. (inherited from SimEntity)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1441
ACT XML Tags
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnSuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1442 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<OnUnsuppress>
Callback that is invoked when the object is unsuppressed. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Callback (p. 57)
Remarks
None.
Examples
None.
Details
CallbackType
Ansys_ACT_Core_Callbacks_OnSuppressedStateChanged
Name
OnUnsuppress
Public
True
Obsolete
False
ObsoleteMessage
None.
ChildType
None.
MinOccurence
MaxOccurence
-1
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1443
ACT XML Tags
RealParent
Ansys_ACT_Core_XmlDataModel_Callbacks
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlTagCallbackAttribute
<Property>
No details provided. (inherited from SimEntity)
Type
Ansys_ACT_Core_XmlDataModel_Property (p. 769)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Property
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1444 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
<TaskGroups>
Task groupings to be exposed as organized blocks within the workflow.
Type
Ansys_ACT_Core_XmlDataModel_TaskGroups (p. 1306)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_TaskGroups
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<Tasks>
Tasks xposed by this workflow.
Type
Ansys_ACT_Core_XmlDataModel_Tasks (p. 1307)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1445
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Tasks
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
BeginGroup=
Indicates whether the load object will have a separator before it when shown in the context menu.
(inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1446 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Details
Name
BeginGroup
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
caption=
Caption of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1447
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
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
class=
Class name of the controller of the object. (inherited from SimEntity)
Type
System_String
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1448 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Remarks
The constructor of the class referenced by this attribute takes two arguments:
Examples
None.
Details
Name
class
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1449
ACT XML Tags
context=
Contexts (application) to which this workflow applies.
Type
System_String_ARRAY_
Remarks
None.
Examples
None.
Details
Name
context
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
True
MappedValues
None.
Public
True
Description
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1450 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
ContextGroup=
Indicates which group the load will be shown in the context menu. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
ContextGroup
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1451
ACT XML Tags
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
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
Name
contextual
Mandatory
False
DefaultValue
True
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1452 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
icon=
Icon for the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
icon
Mandatory
False
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1453
ACT XML Tags
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
LazyActivateSelectProperties=
Determines when onActivate callback is called for the properties. (inherited from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
LazyActivateSelectProperties
Mandatory
False
DefaultValue
False
DataDefinition
False
AllowedValues
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1454 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
localize=
Indicates whether the caption and value string need to be localized by the application. (inherited
from SimEntity)
Type
System_Boolean
Remarks
None.
Examples
None.
Details
Name
localize
Mandatory
False
DefaultValue
False
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1455
ACT XML Tags
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
name=
Name of the object. (inherited from SimEntity)
Type
System_String
Remarks
None.
Examples
None.
Details
Name
name
Mandatory
True
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1456 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
version=
Version of the object. (inherited from SimEntity)
Type
System_Int32
Remarks
None.
Examples
None.
Details
Name
version
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1457
ACT XML Tags
Mandatory
True
DefaultValue
None.
DataDefinition
False
AllowedValues
None.
MultipleValue
False
MappedValues
None.
Public
True
Description
None.
TypeId
Ansys_ACT_Core_Attributes_XmlAttributeAttribute
<Workflow>
Class defining a new application workflow.
Remarks
The name of the application will be a new context available for customization.
Examples
None.
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1458 of ANSYS, Inc. and its subsidiaries and affiliates.
<Workflow>
<ApplicationTaskLink>
Links connecting task in the workflow.
Type
Ansys_ACT_Core_XmlDataModel_Application_ApplicationTaskLink (p. 407)
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_ApplicationTaskLink
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
<UserDefinedTask>
Tasks used by the workflow.
Type
Ansys_ACT_Core_XmlDataModel_Application_UserDefinedTask (p. 1318)
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
of ANSYS, Inc. and its subsidiaries and affiliates. 1459
ACT XML Tags
Remarks
None.
Examples
None.
Details
ChildType
Ansys_ACT_Core_XmlDataModel_Application_UserDefinedTask
MinOccurence
MaxOccurence
-1
RealParent
None.
Mandatory
False
TypeId
Ansys_ACT_Core_Attributes_XmlChildrenTagsAttribute
Release 2023 R1 - © ANSYS, Inc. All rights reserved. - Contains proprietary and confidential information
1460 of ANSYS, Inc. and its subsidiaries and affiliates.