Defines a Stage.
Declaration Syntax
public class Stage : ImportedDataModelObject, IFolderDataModelObject
Table 336: Members
Property | Behavior |
Gets the Behavior. |
Property | Children |
Gets the list of children. |
Property | Comments |
Gets the list of associated comments. |
Property | CyclicRegion |
Gets or sets the CyclicRegion. |
Property | DataModelObjectCategory |
Gets the current DataModelObject's category. |
Property | Figures |
Gets the list of associated figures. |
Property | Images |
Gets the list of associated images. |
Property | InternalObject |
Gets the internal object. For advanced usage only. |
Property | Location |
Gets or sets the Location. |
Property | StageName |
Gets the StageName. |
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 | Delete() |
Run the Delete action. |
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 | GetHarmonicIndexForEnvironmentByIndex(uint, int) |
Gets the worksheet harmonic index for a given environment at index. |
Method | GetHarmonicIndexNumberForEnvironment(uint) |
Gets the worksheet number of harmonic indexes for a given environment. |
Method | SetHarmonicIndexForEnvironmentByIndex(uint, int, uint) |
Sets the worksheet harmonic index for a given environment at index. |
Method | SetHarmonicIndexNumberForEnvironment(uint, uint) |
Sets the worksheet number of harmonic indexes for a given environment. |