Ansys ACT 2024 R2
API and XML Online Reference Guide for Wizard
Index
Global Variable
Features
Step
APIs Description
Ansys.ACT.Interfaces.Common
IAttributeCollection
Methods
GetValue
GetValue
GetStringValue
SetValue
Remove
Contains
Properties
Item
Keys
IExtension
Properties
Name
Version
MinorVersion
ScriptEngine
ScriptScope
UniqueId
InstallDir
Attributes
IExtensionManager
Properties
CurrentExtension
Extensions
ILog
Methods
WriteMessage
WriteWarning
WriteError
StateMessageTypes
Ansys.ACT.Interfaces.DataModel
IDataModelObject
Properties
ObjectType
ObjectLocation
Parent
SupportedLocations
Ansys.ACT.Interfaces.UserInterface
ButtonClickedEventArgs
Constructors
Methods
Equals
GetHashCode
GetType
ToString
Properties
ButtonName
MouseX
MouseY
ButtonPositionType
EntryTypeEnum
IComponentRenderer
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
IContainer
Methods
ShowPanel
Hide
LocalToGlobal
Properties
Renderer
Name
LastMouseX
LastMouseY
CurrentPanel
IEntry
Properties
Name
EntryType
Caption
Visible
Enabled
Checked
Entries
INamed
Properties
Name
INamedCollection<T>
Methods
IndexOf
Insert
RemoveAt
Add
Clear
Contains
CopyTo
Remove
GetEnumerator
GetEnumerator
Properties
Item
Count
IsReadOnly
Item
Names
IRenderer
Methods
CreatePanelContainer
CreateDialogContainer
CreateVirtualContainer
GetContainer
ShowFileOpenDialog
ShowFolderOpenDialog
ShowSaveDialog
CopyToClipboard
GetUnitStringForUI
IToolbar
Properties
Name
Caption
Visible
Entries
IUserInterface
Methods
GetExtensionToolbars
Properties
MainHandle
MainWindow
Toolbars
IsBatchMode
UIRenderer
ProgressMonitor
LinkClickedEventArgs
Constructors
Methods
Equals
GetHashCode
GetType
ToString
Properties
Href
ListItemCheckChangedEventArgs
Constructors
Methods
Equals
GetHashCode
GetType
ToString
Fields
Index
Value
IsChecked
ListItemSelectedEventArgs
Constructors
Methods
Equals
GetHashCode
GetType
ToString
Fields
Index
ToggleButtonClickedEventArgs
Constructors
Methods
Equals
GetHashCode
GetType
ToString
Fields
Checked
Ansys.ACT.Interfaces.UserInterface.Components
ComponentListAlignment
IButtonComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
SetBasicDatas
SetSize
SetImageSize
SetCaptionFontSize
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
Used
Events
IButtonWithMenuComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
SetDatas
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
KeyWords
Tooltip
TopRightInformation
BackgroundColor
HoverBackgroundColor
Events
IChartComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
Reset
ShowLegend
XLabel
YLabel
Y2Label
XTickFormat
YTickFormat
Y2TickFormat
Title
Plot
Bar
Pie
Bubble
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
IDygraphComponent
Methods
Reset
AddSeries
RemoveSeries
DrawPoints
UpdateOptions
UpdateData
SynchronizeWith
Desynchronize
ShowSeries
Properties
XLabel
YLabel
Y2Label
Title
ShowRangeSelector
RangeSelectorPlotFillColor
RangeSelectorPlotStrokeColor
IsSynchronized
IEditorComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
AppendContent
AddAnnotation
ClearAnnotations
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
ScriptScope
Content
UseConsoleKeyBinding
Events
IFrameComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
SetHtmlContent
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
IHelpComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
SetHtmlContent
SetHtmlContent
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
IHtmlComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
SetHtmlContent
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
Events
IImageComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
SetSize
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
Source
AlternateText
Center
IListComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
SetWidth
AddComponent
GetComponent
RemoveComponentByName
ClearComponents
SetOffset
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
Alignment
MaxColumnCount
IPopupMenuComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
GetNewRootMenu
Show
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
MenuRoot
IPropertiesComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
UpdateData
SetProperties
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
Events
ISceneGraphComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
SaveAsImage
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
AutoCenterChildren
AutoFitChildren
Scene
Background
Background2
ISearchBarComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
SetTargetListComponentName
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
HtmlHelp
ITabularDataComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
GetPropertyTable
SetPropertyTable
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
SelectedRows
CanAddDelete
OnlyOneSelect
Events
ITitleComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
SetTitleData
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
ITreeComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
CreateTreeNode
SetTreeRoot
AllowDrop
AllowDrag
AllowSelection
Delete
Select
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
SelectedNode
Events
ITreeGridComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
SetModel
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
IsEditable
Events
Ansys.ACT.Interfaces.UserInterface.Components.ToolbarComponents
IToolbarComponent
Methods
InitDataFromJson
Refresh
AddCSSProperty
Show
Hide
AllowRefresh
SuspendRefresh
AddButton
AddToggleButton
AddDropDownList
AddDropDownCheckList
RemoveTool
Clear
CheckAll
UncheckAll
CheckItem
UncheckItem
ToggleButton
DisableTool
Properties
Container
BottomAttachment
RightAttachment
LeftAttachment
TopAttachment
BottomOffset
RightOffset
LeftOffset
TopOffset
HeightType
WidthType
Height
Width
MaxHeight
MaxWidth
Name
Panel
Tag
IsVisible
HideParentWhenHidden
Tools
Ansys.ACT.Interfaces.UserObject
IPropertyCollection
Methods
IndexOf
Insert
RemoveAt
Add
Clear
Contains
CopyTo
Remove
GetEnumerator
GetEnumerator
Add
Clear
Contains
GetByName
Properties
Item
Count
IsReadOnly
Count
Item
ISimProperty
Methods
OnActivateProperty
OnButtonClick
IsAncestor
Properties
Options
Caption
Control
Controller
DefaultValue
HasUnit
Id
InternalValue
IsGroup
IsTable
IsNativeTable
Displayed
IsValid
Name
ParentCaption
ParentPropertyGroup
QuantityName
ReadOnly
UniqueName
UnitString
Value
ValueString
Visible
Attributes
StateMessage
StateMessageType
Help
CompactUnitString
Buttons
Events
ISimPropertyGroup
Methods
OnActivateProperty
OnButtonClick
IsAncestor
Properties
Options
Caption
Control
Controller
DefaultValue
HasUnit
Id
InternalValue
IsGroup
IsTable
IsNativeTable
Displayed
IsValid
Name
ParentCaption
ParentPropertyGroup
QuantityName
ReadOnly
UniqueName
UnitString
Value
ValueString
Visible
Attributes
StateMessage
StateMessageType
Help
CompactUnitString
Buttons
Display
Properties
AllDescendants
Events
ISimPropertyTable
Methods
OnActivateProperty
OnButtonClick
IsAncestor
SaveActiveRow
AddRow
DeleteRow
Properties
Display
Properties
AllDescendants
Options
Caption
Control
Controller
DefaultValue
HasUnit
Id
InternalValue
IsGroup
IsTable
IsNativeTable
Displayed
IsValid
Name
ParentCaption
ParentPropertyGroup
QuantityName
ReadOnly
UniqueName
UnitString
Value
ValueString
Visible
Attributes
StateMessage
StateMessageType
Help
CompactUnitString
Buttons
RowCount
ActiveRow
ValidState
UpdateStateFreq
Events
IUserObject
Methods
NotifyChange
Properties
ObjectType
ObjectLocation
Parent
SupportedLocations
Id
Name
Version
State
Caption
InternalCaption
Icon
Extension
Controller
Attributes
Properties
AllProperties
Children
ObjectLocationEnum
ObjectTypeEnum
PropertyDisplayEnum
UpdateStateFreqEnum
ValidStateEnum
Ansys.ACT.Interfaces.Wizard
IStepUserInterface
Methods
GetComponent
Properties
Panel
IWizard
Properties
Name
Description
Folder
Filename
Extension
Steps
CurrentStep
IWizardStep
Methods
NotifyChange
Properties
Id
Name
Version
State
Caption
InternalCaption
Icon
Extension
Controller
Attributes
Properties
AllProperties
Children
ObjectType
ObjectLocation
Parent
SupportedLocations
Wizard
IsEnabled
Layout
Context
SystemName
ComponentName
StepId
NextStep
PreviousStep
NextEnabledStep
PreviousEnabledStep
UserInterface
HelpFile
XML Tags
action
Attributes
Name
Type
actions
Attributes
MainAction
Name
actionsview
Attributes
component
name
application
Callbacks
canstart
OnApplicationFinished
OnApplicationStarted
OnBeforeProjectClosed
OnBeforeSave
OnProjectLoaded
Attributes
caption
class
context
icon
name
projectExtName
version
WorkflowToStart
appstoreid
author
author
browserview
Attributes
name
component
Attributes
BottomAttachment
BottomOffset
ComponentType
CustomCSSFile
CustomHTMLFile
CustomJSFile
Height
HeightType
LeftAttachment
LeftOffset
MaxHeight
MaxWidth
MinHeight
MinWidth
name
RightAttachment
RightOffset
TopAttachment
TopOffset
Width
WidthType
componentdata
Attributes
component
componentstyle
Attributes
component
filter
connectto
Attributes
action
event
datamodel
Attributes
icon
name
datamodelview
Attributes
chartComponent
dataModel
imageComponent
name
presentation
propertiesComponent
sceneComponent
tabularComponent
treeComponent
description
description
description
description
description
dialogprogressmonitorview
Attributes
name
extension
Attributes
debug
icon
minorversion
name
version
extension
Attributes
debug
icon
minorversion
name
version
filetoolbarview
Attributes
buttonsComponent
name
image
Callbacks
OnAdd
OnDelete
OnHighlight
OnUnhighlight
OnUpdate
Attributes
allowHighlight
FileNameProperty
userObject
visibility
inputfromactionoutput
Attributes
action
Name
output
inputfromoperator
Attributes
Name
operator
inputvalue
Attributes
Name
layout
Attributes
name
link
Attributes
from
to
nativepropertytable
Callbacks
GetValue
IsValid
IsVisible
OnActivate
OnAdd
OnApply
OnCancel
OnInit
OnMigrate
OnValidate
SetValue
String2Value
Value2String
Attributes
allowempty
caption
class
control
default
display
elementtype
isparameter
keytype
localize
name
needupdate
parameterizable
persistent
readonly
unit
valuetype
visible
visibleon
operator
Attributes
Name
Type
panel
Callbacks
OnPanelHidden
OnPanelInitialized
OnPanelShown
Attributes
class
layout
name
presentations
Attributes
Name
productdatamodelconverter
Callbacks
OnReadInput
OnSendBackData
OnSendData
OnWriteInput
Attributes
dataModel
product
producttask
Attributes
caption
name
product
property
Callbacks
GetValue
IsValid
IsVisible
OnActivate
OnAdd
OnApply
OnCancel
OnInit
OnMigrate
OnValidate
SetValue
String2Value
Value2String
Attributes
caption
class
control
default
elementtype
isparameter
keytype
localize
name
needupdate
parameterizable
persistent
readonly
unit
valuetype
visible
visibleon
propertygroup
Callbacks
GetValue
IsValid
IsVisible
OnActivate
OnAdd
OnApply
OnCancel
OnInit
OnMigrate
OnValidate
SetValue
String2Value
Value2String
Attributes
caption
class
control
default
display
elementtype
isparameter
keytype
localize
name
needupdate
parameterizable
persistent
readonly
unit
valuetype
visible
visibleon
propertytable
Callbacks
GetValue
IsValid
IsVisible
OnActivate
OnAdd
OnApply
OnCancel
OnInit
OnMigrate
OnValidate
SetValue
String2Value
Value2String
Attributes
allowempty
caption
class
control
default
display
elementtype
isparameter
keytype
localize
name
needupdate
parameterizable
persistent
readonly
unit
valuetype
visible
visibleon
scene
Callbacks
OnAdd
OnDelete
OnHighlight
OnUnhighlight
OnUpdate
Attributes
allowHighlight
userObject
visibility
standardaction
Attributes
actionId
caption
name
step
Callbacks
onrefresh
onreset
onupdate
Attributes
BeginGroup
caption
class
Context
ContextGroup
Enabled
helpFile
icon
Layout
LazyActivateSelectProperties
localize
name
version
task
Attributes
Message
Name
Pct
uidefinition
userdefinedtask
Callbacks
onUpdate
Attributes
caption
name
userinputtask
Attributes
caption
name
panel
userobject
Callbacks
Attributes
basedonxmldefinition
BeginGroup
caption
cardinality
class
ContextGroup
icon
LazyActivateSelectProperties
localize
name
parent
version
userobjectconverter
Callbacks
OnReadInput
OnSendBackData
OnSendData
OnWriteInput
Attributes
userObject
wizard
Callbacks
canstart
Attributes
allowNavigation
caption
context
icon
layout
name
persistent
subContext
version
workflow