Comment

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Comment(internalObject: Any)

Bases: object

Defines a Comment.

Overview

Methods

Activate	Activate the current object.
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Author	Gets or sets the Author.
Children	Gets the list of children.
ClsId	ClsId property.
DataModelObjectCategory	Gets the current DataModelObject's category.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
InternalObject	Gets the internal object. For advanced usage only.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
State	State property.
Text	Gets the Text.
VisibleProperties	Gets the list of properties that are visible for this object.

Property detail

property Comment.AttachedRefs: List[int] | None

AttachedRefs property.

property Comment.Author: str | None

Gets or sets the Author.

property Comment.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property Comment.ClsId: int | None

ClsId property.

property Comment.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject's category.

property Comment.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property Comment.IconName: str | None

IconName property.

property Comment.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSCommentAuto | None

Gets the internal object. For advanced usage only.

property Comment.Name: str | None

Name property.

property Comment.ObjectId: int | None

ObjectId property.

property Comment.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

property Comment.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property Comment.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

property Comment.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property Comment.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property Comment.Text: str | None

Gets the Text.

property Comment.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties that are visible for this object.

Method detail

Comment.Activate() → None

Activate the current object.

Comment.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

Comment.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

Comment.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

Comment.Delete() → None

Run the Delete action.

Comment.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

Comment.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

Comment.GetAPIName(dispId: int) → str

Property name bound to dispId.

Comment.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

Comment.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]

Gets the list of children, filtered by type.

Comment.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

Comment.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

Comment.GetHashCode() → int

GetHashCode method.

Comment.GetIconFile() → System.Byte

GetIconFile method.

Comment.GetLifetimeService() → Any

GetLifetimeService method.

Comment.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

Comment.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

Comment.GetPath() → str

GetPath method.

Comment.GetPropertyName(dispId: int) → str

GetPropertyName method.

Comment.GetPropertyValue(name: str) → Any

GetPropertyValue method.

Comment.GetType() → type

GetType method.

Comment.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

Comment.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

Comment.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

Comment.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

Comment.InitializeLifetimeService() → Any

InitializeLifetimeService method.

Comment.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

Comment.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

Comment.PropertyByAPIName(name: str) → Ansys.ACT.Automation.Mechanical.Property

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.

Comment.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

Comment.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

Comment.RemoveParameter(propName: str) → None

Removes the parameter from the parameter set corresponding to the given property.

Comment.ToString() → str

ToString method.