SelectFontFileBuilder Class¶
-
class
NXOpen.Display.
SelectFontFileBuilder
¶ Bases:
NXOpen.Builder
This class is being used in conjunction with the “Select Font File dialog, which is (at least so far) only for internal debugging use.
So no documentation of this class should be published to customers. RDB_FIX What needs to be done to stop this class from being published.
To create a new instance of this class, use
NXOpen.DebugSession.CreateSelectFontFileBuilder()
Default values.
Property Value DeletePreviousText 1 Fill 0 FlipForReadability 1 FontCycling Off Geometry Absolute GlyphHeight 0.125 GlyphSpacingAdjustment 0.0 GlyphWidth 0.125 HiddenStyle Invisible Justification Normal Layout LeftToRight LineSpacingAdjustment 0.0 ReferenceLocation BaselineStart Rotation2d Degrees0 Rotation3d 0 Scale3 0.0 SuppressKerning 0 Vector2X 0.0 Vector2Y 0.0 New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
Border | Returns or sets the border status; whether a rectangular border is displayed for the text. |
DeletePreviousText | Returns or sets the delete behavior; whether previously created text is automatically deleted before displaying new text. |
Fill | Returns or sets the fill status; whether the text box background is filled. |
FlipForReadability | Returns or sets the flip-for-readability status; whether AbsRotScreenSize text should be flipped within its bounding box or fill box if necessary to ensure the text remains readable (front-facing and approximately upright). |
FontCycling | Returns or sets whether available fonts are automatically cycled. |
FontName | Returns or sets the font name: family name of the font |
Geometry | Returns or sets the coordinate spaces of text geometry. |
GlyphHeight | Returns or sets the glyph height. |
GlyphSpacingAdjustment | Returns or sets the extra spacing added between glyphs (positive or negative). |
GlyphWidth | Returns or sets the glyph width. |
HiddenStyle | Returns or sets the behavior of hidden text. |
Justification | Returns or sets the justification of glyphs in the text box. |
Layout | Returns or sets the text layout, which defines the direction in which glyphs advance or flow along a single line, and the direction in which lines advance or flow along a page. |
Leader | Returns or sets the leader status; whether a whether a line is displayed connecting the text to its absolute position. |
Line1 | Returns or sets the first line of text. |
Line2 | Returns or sets the second line of text. |
Line3 | Returns or sets the third line of text. |
LineSpacingAdjustment | Returns or sets the extra spacing added between lines (positive or negative). |
ReferenceLocation | Returns or sets the location on the text box used to position text. |
Rotation2d | Returns or sets the 2D rotation status; how Screen text is rotated in the plane of the screen. |
Rotation3d | Returns or sets the 3D rotation status; whether 3D text is rotated to the current plane of the work view. |
Scale3 | Returns or sets the 3D offset scale for ScreenPoints. |
StyleName | Returns or sets the style name: style of the font |
SuppressKerning | Returns or sets the kerning status; whether kerning is suppressed. |
Tag | Returns the Tag for this object. |
Vector2X | Returns or sets the 2D X offset for ScreenPoints. |
Vector2Y | Returns or sets the 2D Y offset for ScreenPoints. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
SelectFontFileBuilderFontCyclingType Enumeration | Specifies whether available fonts are automatically cycled. |
SelectFontFileBuilderGeometryType Enumeration | Specifies the coordinate spaces of text geometry. |
SelectFontFileBuilderHiddenStyleType Enumeration | Specifies the behavior of hidden text. |
SelectFontFileBuilderJustificationType Enumeration | Specifies how glyphs are justified in the text box. |
SelectFontFileBuilderLayoutType Enumeration | Identifies the text layout, which defines the direction in which glyphs advance or flow along a single line, and the direction in which lines advance or flow along a page. |
SelectFontFileBuilderRefLocation Enumeration | Identifies the location on the text box used to position text. |
SelectFontFileBuilderRotation2dType Enumeration | Specifies how Screen text is rotated in the plane of the screen. |
Property Detail¶
Border¶
-
SelectFontFileBuilder.
Border
¶ Returns or sets the border status; whether a rectangular border is displayed for the text.
-------------------------------------
Getter Method
Signature
Border
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Border
Parameters: border (bool) – New in version NX10.0.0.
License requirements: None.
DeletePreviousText¶
-
SelectFontFileBuilder.
DeletePreviousText
¶ Returns or sets the delete behavior; whether previously created text is automatically deleted before displaying new text.
-------------------------------------
Getter Method
Signature
DeletePreviousText
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DeletePreviousText
Parameters: deletePreviousText (bool) – New in version NX7.5.0.
License requirements: None.
Fill¶
-
SelectFontFileBuilder.
Fill
¶ Returns or sets the fill status; whether the text box background is filled.
-------------------------------------
Getter Method
Signature
Fill
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Fill
Parameters: fill (bool) – New in version NX6.0.0.
License requirements: None.
FlipForReadability¶
-
SelectFontFileBuilder.
FlipForReadability
¶ Returns or sets the flip-for-readability status; whether AbsRotScreenSize text should be “flipped” within its bounding box or fill box if necessary to ensure the text remains readable (front-facing and approximately upright).
-------------------------------------
Getter Method
Signature
FlipForReadability
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FlipForReadability
Parameters: flipForReadability (bool) – New in version NX8.5.0.
License requirements: None.
FontCycling¶
-
SelectFontFileBuilder.
FontCycling
¶ Returns or sets whether available fonts are automatically cycled.
-------------------------------------
Getter Method
Signature
FontCycling
Returns: Return type: NXOpen.Display.SelectFontFileBuilderFontCyclingType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FontCycling
Parameters: fontCycling ( NXOpen.Display.SelectFontFileBuilderFontCyclingType
) –New in version NX7.5.0.
License requirements: None.
FontName¶
-
SelectFontFileBuilder.
FontName
¶ Returns or sets the font name: family name of the font
-------------------------------------
Getter Method
Signature
FontName
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FontName
Parameters: fontName (str) – New in version NX7.5.0.
License requirements: None.
Geometry¶
-
SelectFontFileBuilder.
Geometry
¶ Returns or sets the coordinate spaces of text geometry.
-------------------------------------
Getter Method
Signature
Geometry
Returns: Return type: NXOpen.Display.SelectFontFileBuilderGeometryType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Geometry
Parameters: geometry ( NXOpen.Display.SelectFontFileBuilderGeometryType
) –New in version NX7.5.0.
License requirements: None.
GlyphHeight¶
-
SelectFontFileBuilder.
GlyphHeight
¶ Returns or sets the glyph height.
-------------------------------------
Getter Method
Signature
GlyphHeight
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GlyphHeight
Parameters: glyphHeight (float) – New in version NX7.5.0.
License requirements: None.
GlyphSpacingAdjustment¶
-
SelectFontFileBuilder.
GlyphSpacingAdjustment
¶ Returns or sets the extra spacing added between glyphs (positive or negative).
-------------------------------------
Getter Method
Signature
GlyphSpacingAdjustment
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GlyphSpacingAdjustment
Parameters: glyphSpacingAdjustment (float) – New in version NX7.5.0.
License requirements: None.
GlyphWidth¶
-
SelectFontFileBuilder.
GlyphWidth
¶ Returns or sets the glyph width.
-------------------------------------
Getter Method
Signature
GlyphWidth
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GlyphWidth
Parameters: glyphWidth (float) – New in version NX7.5.0.
License requirements: None.
Justification¶
-
SelectFontFileBuilder.
Justification
¶ Returns or sets the justification of glyphs in the text box.
-------------------------------------
Getter Method
Signature
Justification
Returns: Return type: NXOpen.Display.SelectFontFileBuilderJustificationType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Justification
Parameters: justification ( NXOpen.Display.SelectFontFileBuilderJustificationType
) –New in version NX6.0.0.
License requirements: None.
Layout¶
-
SelectFontFileBuilder.
Layout
¶ Returns or sets the text layout, which defines the direction in which glyphs advance or flow along a single line, and the direction in which lines advance or flow along a page.
-------------------------------------
Getter Method
Signature
Layout
Returns: Return type: NXOpen.Display.SelectFontFileBuilderLayoutType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Layout
Parameters: layout ( NXOpen.Display.SelectFontFileBuilderLayoutType
) –New in version NX7.5.0.
License requirements: None.
Leader¶
-
SelectFontFileBuilder.
Leader
¶ Returns or sets the leader status; whether a whether a line is displayed connecting the text to its absolute position.
-------------------------------------
Getter Method
Signature
Leader
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Leader
Parameters: leader (bool) – New in version NX10.0.0.
License requirements: None.
Line1¶
-
SelectFontFileBuilder.
Line1
¶ Returns or sets the first line of text.
-------------------------------------
Getter Method
Signature
Line1
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Line1
Parameters: line1 (str) – New in version NX7.5.0.
License requirements: None.
Line2¶
-
SelectFontFileBuilder.
Line2
¶ Returns or sets the second line of text.
-------------------------------------
Getter Method
Signature
Line2
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Line2
Parameters: line2 (str) – New in version NX7.5.0.
License requirements: None.
Line3¶
-
SelectFontFileBuilder.
Line3
¶ Returns or sets the third line of text.
-------------------------------------
Getter Method
Signature
Line3
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Line3
Parameters: line3 (str) – New in version NX7.5.0.
License requirements: None.
LineSpacingAdjustment¶
-
SelectFontFileBuilder.
LineSpacingAdjustment
¶ Returns or sets the extra spacing added between lines (positive or negative).
-------------------------------------
Getter Method
Signature
LineSpacingAdjustment
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LineSpacingAdjustment
Parameters: lineSpacingAdjustment (float) – New in version NX7.5.0.
License requirements: None.
ReferenceLocation¶
-
SelectFontFileBuilder.
ReferenceLocation
¶ Returns or sets the location on the text box used to position text.
-------------------------------------
Getter Method
Signature
ReferenceLocation
Returns: Return type: NXOpen.Display.SelectFontFileBuilderRefLocation
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferenceLocation
Parameters: referenceLocation ( NXOpen.Display.SelectFontFileBuilderRefLocation
) –New in version NX6.0.0.
License requirements: None.
Rotation2d¶
-
SelectFontFileBuilder.
Rotation2d
¶ Returns or sets the 2D rotation status; how Screen text is rotated in the plane of the screen.
-------------------------------------
Getter Method
Signature
Rotation2d
Returns: Return type: NXOpen.Display.SelectFontFileBuilderRotation2dType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Rotation2d
Parameters: rotation2d ( NXOpen.Display.SelectFontFileBuilderRotation2dType
) –New in version NX7.5.0.
License requirements: None.
Rotation3d¶
-
SelectFontFileBuilder.
Rotation3d
¶ Returns or sets the 3D rotation status; whether 3D text is rotated to the current plane of the work view.
-------------------------------------
Getter Method
Signature
Rotation3d
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Rotation3d
Parameters: rotation3d (bool) – New in version NX7.5.0.
License requirements: None.
Scale3¶
-
SelectFontFileBuilder.
Scale3
¶ Returns or sets the 3D offset scale for ScreenPoints.
-------------------------------------
Getter Method
Signature
Scale3
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Scale3
Parameters: scale3 (float) – New in version NX7.5.0.
License requirements: None.
StyleName¶
-
SelectFontFileBuilder.
StyleName
¶ Returns or sets the style name: style of the font
-------------------------------------
Getter Method
Signature
StyleName
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StyleName
Parameters: styleName (str) – New in version NX7.5.0.
License requirements: None.
SuppressKerning¶
-
SelectFontFileBuilder.
SuppressKerning
¶ Returns or sets the kerning status; whether kerning is suppressed.
-------------------------------------
Getter Method
Signature
SuppressKerning
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SuppressKerning
Parameters: suppressKerning (bool) – New in version NX7.5.0.
License requirements: None.
Vector2X¶
-
SelectFontFileBuilder.
Vector2X
¶ Returns or sets the 2D X offset for ScreenPoints.
-------------------------------------
Getter Method
Signature
Vector2X
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Vector2X
Parameters: vector2X (float) – New in version NX7.5.0.
License requirements: None.
Vector2Y¶
-
SelectFontFileBuilder.
Vector2Y
¶ Returns or sets the 2D Y offset for ScreenPoints.
-------------------------------------
Getter Method
Signature
Vector2Y
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Vector2Y
Parameters: vector2Y (float) – New in version NX7.5.0.
License requirements: None.
Method Detail¶
Validate¶
-
SelectFontFileBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.