CommandSnippet

Defines a CommandSnippet.

Declaration Syntax

public class CommandSnippet : ImportedDataModelObject, IFolderDataModelObject

Table 172: Members

Property

Children

Gets the list of children.

Property

Comments

Gets the list of associated comments.

Property

DataModelObjectCategory

Gets the current DataModelObject's category.

Property

Figures

Gets the list of associated figures.

Property

FileName

Gets the FileName.

Property

Images

Gets the list of associated images.

Property

Input

Gets or sets the Text.

Property

InputArgument1

Gets or sets the InputArgument1.

Property

InputArgument2

Gets or sets the InputArgument2.

Property

InputArgument3

Gets or sets the InputArgument3.

Property

InputArgument4

Gets or sets the InputArgument4.

Property

InputArgument5

Gets or sets the InputArgument5.

Property

InputArgument6

Gets or sets the InputArgument6.

Property

InputArgument7

Gets or sets the InputArgument7.

Property

InputArgument8

Gets or sets the InputArgument8.

Property

InputArgument9

Gets or sets the InputArgument9.

Property

InternalObject

Gets the internal object. For advanced usage only.

Property

InvalidateSolution

Gets or sets the InvalidateSolution.

Property

IssueSolveCommand

Gets or sets the IssueSolveCommand.

Property

OutputParameters

Gets a list of the command snippet's output parameters.

Property

OutputSearchPrefix

Gets or sets the OutputSearchPrefix.

Property

SnippetFileStatus

Gets the SnippetFileStatus.

Property

SolverTarget

Gets the SolverTarget.

Property

StepNumber

Gets or sets the StepNumber.

Property

StepSelectionMode

Gets or sets the StepSelectionMode.

Property

Suppressed

Gets or sets the Suppressed.

Method

AddComment()

Creates a new child Comment.

Method

AddFigure()

Creates a new child Figure.

Method

AddImage(string)

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.

Method

AppendText(string)

Append Text.

Method

Delete()

Run the Delete action.

Method

ExportTextFile(string)

Export to Textfile.

Method

GetChildren<ChildrenType>(bool, IList<ChildrenType>)

Gets the list of children, filtered by type.

Method

GetChildren(DataModelObjectCategory, bool, IList<IDataModelObject>)

Gets the list of children, filtered by type.

Method

ImportTextFile(string)

Import from Textfile.

Method

RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.