.. vale off :class:`PythonCodeEventBased` ============================= .. py:class:: ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.PythonCodeEventBased Bases: :py:obj:`object` Defines a PythonCodeEventBased. .. !! processed by numpydoc !! .. py:currentmodule:: PythonCodeEventBased Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~ReloadProperties` - Reload properties to update properties provided by the provider. * - :py:attr:`~Connect` - Register the python code. * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~Activate` - Activate the current object. * - :py:attr:`~CopyTo` - Copies all visible properties from this object to another. * - :py:attr:`~Duplicate` - Creates a copy of the current DataModelObject. * - :py:attr:`~GroupAllSimilarChildren` - Run the GroupAllSimilarChildren action. * - :py:attr:`~GroupSimilarObjects` - Run the GroupSimilarObjects action. * - :py:attr:`~PropertyByName` - Get a property by its unique name. * - :py:attr:`~PropertyByAPIName` - Get a property by its API name. * - :py:attr:`~CreateParameter` - Creates a new parameter for a Property. * - :py:attr:`~GetParameter` - Gets the parameter corresponding to the given property. * - :py:attr:`~RemoveParameter` - Removes the parameter from the parameter set corresponding to the given property. .. tab-item:: Properties .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~SolverTarget` - Gets the SolverTarget. * - :py:attr:`~TargetCallback` - Gets or sets the TargetCallback. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~Text` - Gets or sets the text in the script tab for the Python Code object. * - :py:attr:`~PropertyProvider` - Gets or sets the propperty provider instance associated with this python code object. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~ScriptExecutionScope` - The scope identifier in which the code execution will take place. * - :py:attr:`~Connected` - Gets whether the callbacks are currently connected. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~Properties` - Gets the list of properties for this object. * - :py:attr:`~VisibleProperties` - Gets the list of properties that are visible for this object. Property detail --------------- .. py:property:: InternalObject :no-index: :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSPythonCodeEventBasedAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: SolverTarget :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.CommandEditorTarget] Gets the SolverTarget. .. !! processed by numpydoc !! .. py:property:: TargetCallback :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.PythonCodeTargetCallback] Gets or sets the TargetCallback. .. !! processed by numpydoc !! .. py:property:: Suppressed :no-index: :type: Optional[System.Boolean] Gets or sets the Suppressed. .. !! processed by numpydoc !! .. py:property:: DataModelObjectCategory :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory] Gets the current DataModelObject's category. .. !! processed by numpydoc !! .. py:property:: Text :no-index: :type: Optional[System.String] Gets or sets the text in the script tab for the Python Code object. .. !! processed by numpydoc !! .. py:property:: PropertyProvider :no-index: :type: Optional[Ansys.ACT.Interfaces.Mechanical.IPropertyProvider] Gets or sets the propperty provider instance associated with this python code object. .. !! processed by numpydoc !! .. py:property:: InternalObject :no-index: :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSPythonCodeAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: ScriptExecutionScope :no-index: :type: Optional[System.String] The scope identifier in which the code execution will take place. .. !! processed by numpydoc !! .. py:property:: Connected :no-index: :type: Optional[System.Boolean] Gets whether the callbacks are currently connected. .. !! processed by numpydoc !! .. py:property:: InternalObject :no-index: :type: Optional[System.Object] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: Properties :no-index: :type: Optional[System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties for this object. .. !! processed by numpydoc !! .. py:property:: VisibleProperties :no-index: :type: Optional[System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property]] Gets the list of properties that are visible for this object. .. !! processed by numpydoc !! Method detail ------------- .. py:method:: ReloadProperties() -> System.Void :no-index: Reload properties to update properties provided by the provider. .. !! processed by numpydoc !! .. py:method:: Connect() -> System.Void :no-index: Register the python code. .. !! processed by numpydoc !! .. py:method:: Delete() -> System.Void :no-index: Run the Delete action. .. !! processed by numpydoc !! .. py:method:: Activate() -> System.Void :no-index: Activate the current object. .. !! processed by numpydoc !! .. py:method:: CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) -> System.Void :no-index: Copies all visible properties from this object to another. .. !! processed by numpydoc !! .. py:method:: Duplicate() -> Ansys.Mechanical.DataModel.Interfaces.IDataModelObject :no-index: Creates a copy of the current DataModelObject. .. !! processed by numpydoc !! .. py:method:: GroupAllSimilarChildren() -> System.Void :no-index: Run the GroupAllSimilarChildren action. .. !! processed by numpydoc !! .. py:method:: GroupSimilarObjects() -> Ansys.ACT.Automation.Mechanical.TreeGroupingFolder :no-index: Run the GroupSimilarObjects action. .. !! processed by numpydoc !! .. py:method:: PropertyByName(name: System.String) -> Ansys.ACT.Automation.Mechanical.Property :no-index: Get a property by its unique name. .. !! processed by numpydoc !! .. py:method:: PropertyByAPIName(name: System.String) -> Ansys.ACT.Automation.Mechanical.Property :no-index: .. code-block:: text Get a property by its API name. If multiple properties have the same API Name, only the first property with that name will be returned. .. !! processed by numpydoc !! .. py:method:: CreateParameter(propName: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Creates a new parameter for a Property. .. !! processed by numpydoc !! .. py:method:: GetParameter(propName: System.String) -> Ansys.ACT.Interfaces.Mechanical.IParameter :no-index: Gets the parameter corresponding to the given property. .. !! processed by numpydoc !! .. py:method:: RemoveParameter(propName: System.String) -> System.Void :no-index: Removes the parameter from the parameter set corresponding to the given property. .. !! processed by numpydoc !! .. vale on