Class: PeriodicRegion

Defines a PeriodicRegion.

Implemented types

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.
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.
FlipHighLow() Flips the High and Low Boundaries.
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.
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.

Properties

Name Description
Comments Gets the list of associated comments.
CoordinateSystem Gets or sets the CoordinateSystem.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
Figures Gets the list of associated figures.
HighBoundaryLocation Gets or sets the HighBoundaryLocation.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
Location Gets or sets the Location.
LowBoundaryLocation Gets or sets the LowBoundaryLocation.
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.
Parent Gets the parent object.
Properties Gets the list of properties for this object.
ReadOnly Gets or sets the ReadOnly.
ScopeMode Gets the ScopeMode.
Suppressed Gets or sets the Suppressed.
Type Gets or sets the Type.
VisibleProperties Gets the list of properties that are visible for this object.