Class: CommandSnippet

Defines a CommandSnippet.

Methods

Name Description
Activate() Activate the current object.
AddComment() Creates a new child Comment.
AddFigure() Creates a new child Figure.
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.
AppendText(String) Append Text.
CopyTo(DataModelObject) Copies all visible properties from this object to another.
CreateParameter(String) Creates a new parameter for a Property.
Delete() Run the Delete action.
Duplicate() Creates a copy of the current DataModelObject.
ExportTextFile(String) Export to Textfile.
GetParameter(String) Gets the parameter corresponding to the given property.
GetPath() Gets the path of the object.
GroupAllSimilarChildren() Run the GroupAllSimilarChildren action.
GroupSimilarObjects() Run the GroupSimilarObjects action.
ImportTextFile(String) Import from Textfile.
PropertyByAPIName(String) 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.
PropertyByName(String) Get a property by its unique name.
RemoveParameter(String) Removes the parameter from the parameter set corresponding to the given property.
RenameBasedOnDefinition() Run the RenameBasedOnDefinition action.

Properties

Name Description
Comments Gets the list of associated comments.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
Figures Gets the list of associated figures.
FileName Gets the FileName.
Images Gets the list of associated images.
Input Gets or sets the Text.
InputArgument1 Gets or sets the InputArgument1.
InputArgument2 Gets or sets the InputArgument2.
InputArgument3 Gets or sets the InputArgument3.
InputArgument4 Gets or sets the InputArgument4.
InputArgument5 Gets or sets the InputArgument5.
InputArgument6 Gets or sets the InputArgument6.
InputArgument7 Gets or sets the InputArgument7.
InputArgument8 Gets or sets the InputArgument8.
InputArgument9 Gets or sets the InputArgument9.
InternalObject Gets the internal object. For advanced usage only.
InvalidateSolution Gets or sets the InvalidateSolution.
IssueSolveCommand Gets or sets the IssueSolveCommand.
Name Gets the name of the object.
ObjectId Gets the internal id of the object.
ObjectTags Gets an IEnumerable object of the tags that 'this' is a part of.
OutputParameters Gets a list of the command snippet's output parameters.
OutputSearchPrefix Gets or sets the OutputSearchPrefix.
Parent Gets the parent object.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
SnippetFileStatus Gets the SnippetFileStatus.
SolverTarget Gets the SolverTarget.
StepNumber Gets or sets the StepNumber.
StepSelectionMode Gets or sets the StepSelectionMode.
Suppressed Gets or sets the Suppressed.
VisibleProperties Gets the list of properties that are visible for this object.