MultilineString Class¶
-
class
NXOpen.BlockStyler.MultilineString¶ Bases:
NXOpen.BlockStyler.UIBlockRepresents a Multiline String block
New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| Enable | Returns or sets the Enable. |
| Expanded | Returns or sets the Expanded |
| Group | Returns or sets the Group |
| Height | Returns or sets the Height |
| Label | Returns or sets the Label |
| Localize | Returns or sets the Localize. |
| MaximumCharactersAccepted | Returns or sets the MaximumCharactersAccepted |
| MaximumHeight | Returns or sets the MaximumHeight |
| MinimumHeight | Returns or sets the MinimumHeight |
| Name | Returns the name of the block or BlockID |
| ResizeHeightWithDialog | Returns or sets the ResizeHeightWithDialog. |
| RetainValue | Returns or sets the RetainValue |
| Show | Returns or sets the Visibility of block. |
| Tag | Returns the Tag for this object. |
| Type | Returns the type of block |
| ValuesConcatenated | Returns or sets the ValuesConcatenated. |
| Width | Returns or sets the Width |
Methods¶
| Method | Description |
|---|---|
| Focus | Focuses on the block. |
| GetProperties | Returns the properties of the block @return |
| GetValue | Gets the Value @return |
| SetValue | Sets the Value |
Property Detail¶
Height¶
-
MultilineString.Height¶ Returns or sets the Height
-------------------------------------Getter Method
Signature
Height()Returns: Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Height(height)Parameters: height (int) – New in version NX8.5.0.
License requirements: None.
Localize¶
-
MultilineString.Localize¶ Returns or sets the Localize.
If true, the Label is translated to current locale language
-------------------------------------Getter Method
Signature
Localize()Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Localize(localize)Parameters: localize (bool) – New in version NX8.5.0.
License requirements: None.
MaximumCharactersAccepted¶
-
MultilineString.MaximumCharactersAccepted¶ Returns or sets the MaximumCharactersAccepted
-------------------------------------Getter Method
Signature
MaximumCharactersAccepted()Returns: Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MaximumCharactersAccepted(maxChar)Parameters: maxChar (int) – New in version NX8.5.0.
License requirements: None.
MaximumHeight¶
-
MultilineString.MaximumHeight¶ Returns or sets the MaximumHeight
-------------------------------------Getter Method
Signature
MaximumHeight()Returns: Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MaximumHeight(maxHeight)Parameters: maxHeight (int) – New in version NX8.5.0.
License requirements: None.
MinimumHeight¶
-
MultilineString.MinimumHeight¶ Returns or sets the MinimumHeight
-------------------------------------Getter Method
Signature
MinimumHeight()Returns: Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MinimumHeight(minHeight)Parameters: minHeight (int) – New in version NX8.5.0.
License requirements: None.
ResizeHeightWithDialog¶
-
MultilineString.ResizeHeightWithDialog¶ Returns or sets the ResizeHeightWithDialog.
If true, height of block will dynamically change when the dialog is resized.
-------------------------------------Getter Method
Signature
ResizeHeightWithDialog()Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ResizeHeightWithDialog(resize)Parameters: resize (bool) – New in version NX8.5.0.
License requirements: None.
RetainValue¶
-
MultilineString.RetainValue¶ Returns or sets the RetainValue
-------------------------------------Getter Method
Signature
RetainValue()Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RetainValue(retain)Parameters: retain (bool) – New in version NX8.5.0.
License requirements: None.
ValuesConcatenated¶
-
MultilineString.ValuesConcatenated¶ Returns or sets the ValuesConcatenated.
Represents single string with values in block concatenated with new-line characters.
-------------------------------------Getter Method
Signature
ValuesConcatenated()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ValuesConcatenated(valueString)Parameters: valueString (str) – New in version NX8.5.0.
License requirements: None.
Width¶
-
MultilineString.Width¶ Returns or sets the Width
-------------------------------------Getter Method
Signature
Width()Returns: Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Width(width)Parameters: width (int) – New in version NX8.5.0.
License requirements: None.