Ansys ACT 2025 R1
API and XML Online Reference Guide for Project

Index
Global Variable
Features
- entity
- entry
- input
- output
- parameter
- rsmjob
- task
- task
- taskgroup
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
  - IParameterManager
    - Properties
      - Parameters
  - StateMessageTypes
- Ansys.ACT.Interfaces.DataModel
  - IDataModelObject
    - Properties
- Ansys.ACT.Interfaces.Project
  - IProjectDataModel
    - Methods
    - Properties
      - Tasks
      - TaskGroups
- Ansys.ACT.Interfaces.UserInterface
  - ButtonClickedEventArgs
    - Constructors
    - Methods
      - Equals
      - GetHashCode
      - GetType
      - ToString
    - Properties
      - ButtonName
      - MouseX
      - MouseY
  - ButtonPositionType
  - EntryTypeEnum
  - IComponentRenderer
    - Methods
    - Properties
      - Container
      - BottomAttachment
      - RightAttachment
      - LeftAttachment
      - TopAttachment
      - BottomOffset
      - RightOffset
      - LeftOffset
      - TopOffset
      - HeightType
      - WidthType
      - Height
      - Width
      - MaxHeight
      - MaxWidth
      - Name
      - Panel
      - Tag
      - IsVisible
      - HideParentWhenHidden
  - IContainer
    - Methods
    - 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
  - IToolbar
    - Properties
      - Name
      - Caption
      - Visible
      - Entries
  - IUserInterface
    - Methods
      - GetExtensionToolbars
    - Properties
  - 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
    - 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
    - Properties
  - IEditorComponent
    - Methods
    - 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
    - Properties
      - Container
      - BottomAttachment
      - RightAttachment
      - LeftAttachment
      - TopAttachment
      - BottomOffset
      - RightOffset
      - LeftOffset
      - TopOffset
      - HeightType
      - WidthType
      - Height
      - Width
      - MaxHeight
      - MaxWidth
      - Name
      - Panel
      - Tag
      - IsVisible
      - HideParentWhenHidden
  - IHelpComponent
    - Methods
    - Properties
      - Container
      - BottomAttachment
      - RightAttachment
      - LeftAttachment
      - TopAttachment
      - BottomOffset
      - RightOffset
      - LeftOffset
      - TopOffset
      - HeightType
      - WidthType
      - Height
      - Width
      - MaxHeight
      - MaxWidth
      - Name
      - Panel
      - Tag
      - IsVisible
      - HideParentWhenHidden
  - IHtmlComponent
    - Methods
    - 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
    - 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
    - Properties
      - Container
      - BottomAttachment
      - RightAttachment
      - LeftAttachment
      - TopAttachment
      - BottomOffset
      - RightOffset
      - LeftOffset
      - TopOffset
      - HeightType
      - WidthType
      - Height
      - Width
      - MaxHeight
      - MaxWidth
      - Name
      - Panel
      - Tag
      - IsVisible
      - HideParentWhenHidden
    - Events
  - ISceneGraphComponent
    - Methods
    - 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
    - Properties
      - Container
      - BottomAttachment
      - RightAttachment
      - LeftAttachment
      - TopAttachment
      - BottomOffset
      - RightOffset
      - LeftOffset
      - TopOffset
      - HeightType
      - WidthType
      - Height
      - Width
      - MaxHeight
      - MaxWidth
      - Name
      - Panel
      - Tag
      - IsVisible
      - HideParentWhenHidden
      - HtmlHelp
  - ITabularDataComponent
    - Methods
    - 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
    - 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
    - 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
    - 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
    - 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
    - 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.Workflow
  - ITaskInput
    - Methods
      - NotifyChange
    - Properties
      - Id
      - Name
      - Version
      - State
      - Caption
      - InternalCaption
      - Icon
      - Extension
      - Controller
      - Attributes
      - Properties
      - AllProperties
      - Children
      - ObjectType
      - ObjectLocation
      - Parent
      - SupportedLocations
  - ITaskOutput
    - Methods
      - NotifyChange
    - Properties
      - Id
      - Name
      - Version
      - State
      - Caption
      - InternalCaption
      - Icon
      - Extension
      - Controller
      - Attributes
      - Properties
      - AllProperties
      - Children
      - ObjectType
      - ObjectLocation
      - Parent
      - SupportedLocations
  - IWorkflowTask
    - Methods
      - NotifyChange
    - Properties
      - Id
      - Name
      - Version
      - State
      - Caption
      - InternalCaption
      - Icon
      - Extension
      - Controller
      - Attributes
      - Properties
      - AllProperties
      - Children
      - ObjectType
      - ObjectLocation
      - Parent
      - SupportedLocations
      - ParameterManager
      - Outputs
      - Inputs
      - Children
      - SourceTasks
      - InternalObject
      - Type
      - TaskGroup
      - CellId
  - IWorkflowTaskGroup
    - Methods
      - NotifyChange
    - Properties
      - Id
      - Name
      - Version
      - State
      - Caption
      - InternalCaption
      - Icon
      - Extension
      - Controller
      - Attributes
      - Properties
      - AllProperties
      - Children
      - ObjectType
      - ObjectLocation
      - Parent
      - SupportedLocations
      - Tasks
      - InternalObject
XML Tags
- action
  - Attributes
    - Name
    - Type
- actions
  - Attributes
    - MainAction
    - Name
- appstoreid
- assembly
  - Attributes
    - context
    - namespace
    - src
- author
- author
- connectto
  - Attributes
    - action
    - event
- description
- description
- entity
  - Callbacks
    - CanAdd
    - CanCreate
    - OnAdd
    - OnInit
    - OnMigrate
  - Attributes
    - BeginGroup
    - caption
    - class
    - ContextGroup
    - datatype
    - icon
    - LazyActivateSelectProperties
    - localize
    - name
    - version
- entry
  - Callbacks
    - OnClick
  - Attributes
    - caption
    - Icon
    - localize
    - name
    - userobject
- entry
  - Callbacks
    - onclick
  - Attributes
    - caption
    - icon
    - name
    - priority
    - type
    - version
- extension
  - Attributes
    - debug
    - icon
    - minorversion
    - name
    - version
- extension
  - Attributes
    - debug
    - icon
    - minorversion
    - name
    - version
- guid
  - Attributes
    - shortid
- images
- input
  - Attributes
    - count
    - format
    - type
- inputfromactionoutput
  - Attributes
    - action
    - Name
    - output
- inputfromoperator
  - Attributes
    - Name
    - operator
- inputvalue
  - Attributes
    - Name
- interface
  - Callbacks
  - Attributes
    - context
    - propertyEvents
- 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
    - readonlyon
    - unit
    - valuetype
    - visible
    - visibleon
- operator
  - Attributes
    - Name
    - Type
- output
  - Attributes
    - format
    - type
- parameter
  - Callbacks
    - CanAdd
    - CanCreate
    - OnAdd
    - OnInit
    - OnMigrate
  - Attributes
    - BeginGroup
    - caption
    - class
    - ContextGroup
    - control
    - icon
    - LazyActivateSelectProperties
    - localize
    - name
    - usage
    - version
- 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
    - readonlyon
    - 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
    - readonlyon
    - 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
    - readonlyon
    - unit
    - valuetype
    - visible
    - visibleon
- rsmjob
  - Callbacks
  - Attributes
    - BeginGroup
    - caption
    - class
    - ContextGroup
    - deletefiles
    - icon
    - LazyActivateSelectProperties
    - localize
    - name
    - version
- script
  - Attributes
    - compiled
    - context
    - src
- separator
- simdata
  - Attributes
    - context
- simdata
  - Attributes
    - context
- target
  - Attributes
    - location
    - name
    - type
- task
  - Callbacks
    - CanAdd
    - canconsumedata
    - CanCreate
    - OnAdd
    - onclean
    - ondelete
    - onedit
    - OnInit
    - oninitialize
    - onload
    - OnMigrate
    - onrefresh
    - onreport
    - onreset
    - onstatus
    - onupdate
  - Attributes
- taskgroup
  - Callbacks
    - CanAdd
    - CanCreate
    - OnAdd
    - OnInit
    - OnMigrate
  - Attributes
    - abbreviation
    - BeginGroup
    - caption
    - category
    - class
    - ContextGroup
    - headertext
    - icon
    - isparametricgroup
    - LazyActivateSelectProperties
    - localize
    - name
    - version
- toolbar
  - Attributes
    - caption
    - localize
    - name
- workflow
  - Callbacks
  - Attributes
    - BeginGroup
    - caption
    - class
    - context
    - ContextGroup
    - icon
    - LazyActivateSelectProperties
    - localize
    - name
    - version

Generated on November 22, 2024
© Copyright 2024 ANSYS, Inc.