.. vale off :class:`CommandSnippet` ======================= .. py:class:: ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.CommandSnippet Bases: :py:obj:`object` Defines a CommandSnippet. .. !! processed by numpydoc !! .. py:currentmodule:: CommandSnippet Overview -------- .. tab-set:: .. tab-item:: Methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~AppendText` - Append Text. * - :py:attr:`~ImportTextFile` - Import from Textfile. * - :py:attr:`~ExportTextFile` - Export to Textfile. * - :py:attr:`~RenameBasedOnDefinition` - Run the RenameBasedOnDefinition action. * - :py:attr:`~Delete` - Run the Delete action. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~GetChildren` - Gets the list of children, filtered by type. * - :py:attr:`~AddComment` - Creates a new child Comment. * - :py:attr:`~AddFigure` - Creates a new child Figure. * - :py:attr:`~AddImage` - Creates a new child Image. * - :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:`~Input` - Gets or sets the Text. * - :py:attr:`~OutputParameters` - Gets a list of the command snippet's output parameters. * - :py:attr:`~InternalObject` - Gets the internal object. For advanced usage only. * - :py:attr:`~InputArgument1` - Gets or sets the InputArgument1. * - :py:attr:`~InputArgument2` - Gets or sets the InputArgument2. * - :py:attr:`~InputArgument3` - Gets or sets the InputArgument3. * - :py:attr:`~InputArgument4` - Gets or sets the InputArgument4. * - :py:attr:`~InputArgument5` - Gets or sets the InputArgument5. * - :py:attr:`~InputArgument6` - Gets or sets the InputArgument6. * - :py:attr:`~InputArgument7` - Gets or sets the InputArgument7. * - :py:attr:`~InputArgument8` - Gets or sets the InputArgument8. * - :py:attr:`~InputArgument9` - Gets or sets the InputArgument9. * - :py:attr:`~OutputSearchPrefix` - Gets or sets the OutputSearchPrefix. * - :py:attr:`~StepNumber` - Gets or sets the StepNumber. * - :py:attr:`~FileName` - Gets the FileName. * - :py:attr:`~SnippetFileStatus` - Gets the SnippetFileStatus. * - :py:attr:`~StepSelectionMode` - Gets or sets the StepSelectionMode. * - :py:attr:`~SolverTarget` - Gets the SolverTarget. * - :py:attr:`~IssueSolveCommand` - Gets or sets the IssueSolveCommand. * - :py:attr:`~InvalidateSolution` - Gets or sets the InvalidateSolution. * - :py:attr:`~Suppressed` - Gets or sets the Suppressed. * - :py:attr:`~DataModelObjectCategory` - Gets the current DataModelObject's category. * - :py:attr:`~Children` - Gets the list of children. * - :py:attr:`~Comments` - Gets the list of associated comments. * - :py:attr:`~Figures` - Gets the list of associated figures. * - :py:attr:`~Images` - Gets the list of associated images. * - :py:attr:`~ReadOnly` - Gets or sets the ReadOnly. * - :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:: Input :no-index: :type: Optional[System.String] Gets or sets the Text. .. !! processed by numpydoc !! .. py:property:: OutputParameters :no-index: :type: Optional[System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.CommandOutputParameter]] Gets a list of the command snippet's output parameters. .. !! processed by numpydoc !! .. py:property:: InternalObject :no-index: :type: Optional[Ansys.Common.Interop.DSObjectsAuto.IDSCommandEditorAuto] Gets the internal object. For advanced usage only. .. !! processed by numpydoc !! .. py:property:: InputArgument1 :no-index: :type: Optional[System.String] Gets or sets the InputArgument1. .. !! processed by numpydoc !! .. py:property:: InputArgument2 :no-index: :type: Optional[System.String] Gets or sets the InputArgument2. .. !! processed by numpydoc !! .. py:property:: InputArgument3 :no-index: :type: Optional[System.String] Gets or sets the InputArgument3. .. !! processed by numpydoc !! .. py:property:: InputArgument4 :no-index: :type: Optional[System.String] Gets or sets the InputArgument4. .. !! processed by numpydoc !! .. py:property:: InputArgument5 :no-index: :type: Optional[System.String] Gets or sets the InputArgument5. .. !! processed by numpydoc !! .. py:property:: InputArgument6 :no-index: :type: Optional[System.String] Gets or sets the InputArgument6. .. !! processed by numpydoc !! .. py:property:: InputArgument7 :no-index: :type: Optional[System.String] Gets or sets the InputArgument7. .. !! processed by numpydoc !! .. py:property:: InputArgument8 :no-index: :type: Optional[System.String] Gets or sets the InputArgument8. .. !! processed by numpydoc !! .. py:property:: InputArgument9 :no-index: :type: Optional[System.String] Gets or sets the InputArgument9. .. !! processed by numpydoc !! .. py:property:: OutputSearchPrefix :no-index: :type: Optional[System.String] Gets or sets the OutputSearchPrefix. .. !! processed by numpydoc !! .. py:property:: StepNumber :no-index: :type: Optional[System.Int32] Gets or sets the StepNumber. .. !! processed by numpydoc !! .. py:property:: FileName :no-index: :type: Optional[System.String] Gets the FileName. .. !! processed by numpydoc !! .. py:property:: SnippetFileStatus :no-index: :type: Optional[System.Int32] Gets the SnippetFileStatus. .. !! processed by numpydoc !! .. py:property:: StepSelectionMode :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.SequenceSelectionType] Gets or sets the StepSelectionMode. .. !! processed by numpydoc !! .. py:property:: SolverTarget :no-index: :type: Optional[Ansys.Mechanical.DataModel.Enums.CommandEditorTarget] Gets the SolverTarget. .. !! processed by numpydoc !! .. py:property:: IssueSolveCommand :no-index: :type: Optional[System.Boolean] Gets or sets the IssueSolveCommand. .. !! processed by numpydoc !! .. py:property:: InvalidateSolution :no-index: :type: Optional[System.Boolean] Gets or sets the InvalidateSolution. .. !! 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:: Children :no-index: :type: Optional[System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]] Gets the list of children. .. !! processed by numpydoc !! .. py:property:: Comments :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment]] Gets the list of associated comments. .. !! processed by numpydoc !! .. py:property:: Figures :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure]] Gets the list of associated figures. .. !! processed by numpydoc !! .. py:property:: Images :no-index: :type: Optional[System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image]] Gets the list of associated images. .. !! processed by numpydoc !! .. py:property:: ReadOnly :no-index: :type: Optional[System.Boolean] Gets or sets the ReadOnly. .. !! 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:: AppendText(NewText: System.String) -> System.Void :no-index: Append Text. .. !! processed by numpydoc !! .. py:method:: ImportTextFile(TextFile: System.String) -> System.Void :no-index: Import from Textfile. .. !! processed by numpydoc !! .. py:method:: ExportTextFile(TextFile: System.String) -> System.Void :no-index: Export to Textfile. .. !! processed by numpydoc !! .. py:method:: RenameBasedOnDefinition() -> System.Void :no-index: Run the RenameBasedOnDefinition action. .. !! processed by numpydoc !! .. py:method:: Delete() -> System.Void :no-index: Run the Delete action. .. !! processed by numpydoc !! .. py:method:: GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) -> System.Collections.Generic.IList[ChildrenType] :no-index: Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) -> System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] :no-index: Gets the list of children, filtered by type. .. !! processed by numpydoc !! .. py:method:: AddComment() -> Ansys.ACT.Automation.Mechanical.Comment :no-index: Creates a new child Comment. .. !! processed by numpydoc !! .. py:method:: AddFigure() -> Ansys.ACT.Automation.Mechanical.Figure :no-index: Creates a new child Figure. .. !! processed by numpydoc !! .. py:method:: AddImage(filePath: System.String) -> Ansys.ACT.Automation.Mechanical.Image :no-index: .. code-block:: text Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the image will be a screen capture of the Geometry window. .. !! 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