TextBuilder Class

class NXOpen.Features.TextBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents a NXOpen.Features.Text builder

To create a new instance of this class, use NXOpen.Features.FeatureCollection.CreateTextBuilder()

Default values.

Property Value
CanCreateBoundingBox 0
CanJoinCurves 1
CanProjectCurves 0
CanReferenceText 0
CanUseKerningSpaces 1
FontStyle Regular
FrameOnPath.AnchorLocation Center
FrameOnPath.Height.Value 10 (millimeters part), 1 (inches part)
FrameOnPath.Offset.Value 0 (millimeters part), 0 (inches part)
FrameOnPath.WScale 100
IsAssociative 1
OnFacePlacementMethod CurvesOnFaces
OrientationMethod Natural
PlanarFrame.AnchorLocation BottomCenter
PlanarFrame.Height.Value 10 (millimeters part), 1 (inches part)
PlanarFrame.Shear.Value 0
PlanarFrame.WScale 100

New in version NX7.5.1.

Properties

Property Description
CanCreateBoundingBox Returns or sets the flag indicating if bounding box can be created
CanJoinCurves Returns or sets the flag indicating if curves can be joined
CanProjectCurves Returns or sets the flag indicating if curves can be projected
CanReferenceText Returns or sets the flag indicating if text feature can reference a string expression
CanReverseIntersectionCurve Returns or sets the flag indicating if intersection curve can be reversed
CanUseKerningSpaces Returns or sets the flag indicating if kerning spaces can be used
Font Returns the font
FontStyle Returns or sets the font style
FrameOnPath Returns the frame on path
IsAssociative Returns or sets the flag indicating if operation is associative
OnCurvePlacementProfile Returns the placement profile for NXOpen.Features.TextBuilderTypes.OnCurve type
OnFacePlacementMethod Returns or sets the placement method for NXOpen.Features.TextBuilderTypes.OnFace type
OnFacePlacementProfile Returns the placement profile for NXOpen.Features.TextBuilderTypes.OnFace type
OrientationMethod Returns or sets the orientation method for NXOpen.Features.TextBuilderTypes.OnCurve type
OrientationVector Returns or sets the orientation vector
ParentFeatureInternal Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag Returns or sets the patch solution flag
PatchSurfaceFilename Returns or sets the patch surface filename
PlacementFaces Returns the placement faces for NXOpen.Features.TextBuilderTypes.OnFace type
PlanarFrame Returns the planar frame
Script Returns or sets the script
SectionPlane Returns or sets the section plane for NXOpen.Features.TextBuilderTypes.OnFace type
SurroundingPatchSurfaceFilename Returns or sets the surrounding patch surface filename
Tag Returns the Tag for this object.
Text Returns the string expression representing the text
TextString Returns or sets the string to be rendered
Type Returns or sets the type

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
CommitFeature Commits the feature parameters and creates the feature
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.
GetFeature Returns the feature currently being edited by this builder.
GetObject Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit Re-suppress an internal parent feature (a slave feature) after it has been edited.
SelectFont Selects the font along with appropriate character set
SetParentFeatureInternal Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal Set the internal parent feature of the feature being edited to external
UpdateOnOrientationVectorReversal Updates the builder based on orientation vector sense
UpdateOnSectionPlane Updates the builder based on section plane
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

CanCreateBoundingBox

TextBuilder.CanCreateBoundingBox

Returns or sets the flag indicating if bounding box can be created

-------------------------------------

Getter Method

Signature CanCreateBoundingBox

Returns:
Return type:bool

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature CanCreateBoundingBox

Parameters:canCreateBoundingBox (bool) –

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

CanJoinCurves

TextBuilder.CanJoinCurves

Returns or sets the flag indicating if curves can be joined

-------------------------------------

Getter Method

Signature CanJoinCurves

Returns:
Return type:bool

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature CanJoinCurves

Parameters:canJoinCurves (bool) –

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

CanProjectCurves

TextBuilder.CanProjectCurves

Returns or sets the flag indicating if curves can be projected

-------------------------------------

Getter Method

Signature CanProjectCurves

Returns:
Return type:bool

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature CanProjectCurves

Parameters:canProjectCurves (bool) –

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

CanReferenceText

TextBuilder.CanReferenceText

Returns or sets the flag indicating if text feature can reference a string expression

-------------------------------------

Getter Method

Signature CanReferenceText

Returns:
Return type:bool

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature CanReferenceText

Parameters:canReferenceText (bool) –

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

CanReverseIntersectionCurve

TextBuilder.CanReverseIntersectionCurve

Returns or sets the flag indicating if intersection curve can be reversed

-------------------------------------

Getter Method

Signature CanReverseIntersectionCurve

Returns:
Return type:bool

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature CanReverseIntersectionCurve

Parameters:canReverse (bool) –

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

CanUseKerningSpaces

TextBuilder.CanUseKerningSpaces

Returns or sets the flag indicating if kerning spaces can be used

-------------------------------------

Getter Method

Signature CanUseKerningSpaces

Returns:
Return type:bool

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature CanUseKerningSpaces

Parameters:canUseKerningSpaces (bool) –

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

Font

TextBuilder.Font

Returns the font

-------------------------------------

Getter Method

Signature Font

Returns:
Return type:str

New in version NX7.5.1.

License requirements: None.

FontStyle

TextBuilder.FontStyle

Returns or sets the font style

-------------------------------------

Getter Method

Signature FontStyle

Returns:
Return type:NXOpen.Features.TextBuilderFontStyleOptions

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature FontStyle

Parameters:fontStyle (NXOpen.Features.TextBuilderFontStyleOptions) –

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

FrameOnPath

TextBuilder.FrameOnPath

Returns the frame on path

-------------------------------------

Getter Method

Signature FrameOnPath

Returns:
Return type:NXOpen.GeometricUtilities.FrameOnPathBuilder

New in version NX7.5.1.

License requirements: None.

IsAssociative

TextBuilder.IsAssociative

Returns or sets the flag indicating if operation is associative

-------------------------------------

Getter Method

Signature IsAssociative

Returns:
Return type:bool

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature IsAssociative

Parameters:isAssociative (bool) –

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

OnCurvePlacementProfile

TextBuilder.OnCurvePlacementProfile

Returns the placement profile for NXOpen.Features.TextBuilderTypes.OnCurve type

-------------------------------------

Getter Method

Signature OnCurvePlacementProfile

Returns:
Return type:NXOpen.Section

New in version NX7.5.1.

License requirements: None.

OnFacePlacementMethod

TextBuilder.OnFacePlacementMethod

Returns or sets the placement method for NXOpen.Features.TextBuilderTypes.OnFace type

-------------------------------------

Getter Method

Signature OnFacePlacementMethod

Returns:
Return type:NXOpen.Features.TextBuilderOnFacePlacementMethodOptions

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature OnFacePlacementMethod

Parameters:placementMethod (NXOpen.Features.TextBuilderOnFacePlacementMethodOptions) –

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

OnFacePlacementProfile

TextBuilder.OnFacePlacementProfile

Returns the placement profile for NXOpen.Features.TextBuilderTypes.OnFace type

-------------------------------------

Getter Method

Signature OnFacePlacementProfile

Returns:
Return type:NXOpen.Section

New in version NX7.5.1.

License requirements: None.

OrientationMethod

TextBuilder.OrientationMethod

Returns or sets the orientation method for NXOpen.Features.TextBuilderTypes.OnCurve type

-------------------------------------

Getter Method

Signature OrientationMethod

Returns:
Return type:NXOpen.Features.TextBuilderOrientationMethodOptions

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature OrientationMethod

Parameters:orientationMethod (NXOpen.Features.TextBuilderOrientationMethodOptions) –

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

OrientationVector

TextBuilder.OrientationVector

Returns or sets the orientation vector

-------------------------------------

Getter Method

Signature OrientationVector

Returns:
Return type:NXOpen.Direction

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature OrientationVector

Parameters:orientationVector (NXOpen.Direction) –

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

PlacementFaces

TextBuilder.PlacementFaces

Returns the placement faces for NXOpen.Features.TextBuilderTypes.OnFace type

-------------------------------------

Getter Method

Signature PlacementFaces

Returns:
Return type:NXOpen.ScCollector

New in version NX7.5.1.

License requirements: None.

PlanarFrame

TextBuilder.PlanarFrame

Returns the planar frame

-------------------------------------

Getter Method

Signature PlanarFrame

Returns:
Return type:NXOpen.GeometricUtilities.RectangularFrameBuilder

New in version NX7.5.1.

License requirements: None.

Script

TextBuilder.Script

Returns or sets the script

-------------------------------------

Getter Method

Signature Script

Returns:
Return type:NXOpen.Features.TextBuilderScriptOptions

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature Script

Parameters:script (NXOpen.Features.TextBuilderScriptOptions) –

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

SectionPlane

TextBuilder.SectionPlane

Returns or sets the section plane for NXOpen.Features.TextBuilderTypes.OnFace type

-------------------------------------

Getter Method

Signature SectionPlane

Returns:
Return type:NXOpen.Plane

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature SectionPlane

Parameters:sectionPlane (NXOpen.Plane) –

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

Text

TextBuilder.Text

Returns the string expression representing the text

-------------------------------------

Getter Method

Signature Text

Returns:
Return type:NXOpen.Expression

New in version NX7.5.1.

License requirements: None.

TextString

TextBuilder.TextString

Returns or sets the string to be rendered

-------------------------------------

Getter Method

Signature TextString

Returns:Copy of the text referenced by the builder
Return type:str

New in version NX7.5.3.

License requirements: None.

-------------------------------------

Setter Method

Signature TextString

Parameters:textString (str) – Text to be rendered

New in version NX7.5.3.

License requirements: solid_modeling (“SOLIDS MODELING”)

Type

TextBuilder.Type

Returns or sets the type

-------------------------------------

Getter Method

Signature Type

Returns:
Return type:NXOpen.Features.TextBuilderTypes

New in version NX7.5.1.

License requirements: None.

-------------------------------------

Setter Method

Signature Type

Parameters:type (NXOpen.Features.TextBuilderTypes) –

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

Method Detail

SelectFont

TextBuilder.SelectFont

Selects the font along with appropriate character set

Signature SelectFont(fontName, script)

Parameters:

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

UpdateOnOrientationVectorReversal

TextBuilder.UpdateOnOrientationVectorReversal

Updates the builder based on orientation vector sense

Signature UpdateOnOrientationVectorReversal()

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

UpdateOnSectionPlane

TextBuilder.UpdateOnSectionPlane

Updates the builder based on section plane

Signature UpdateOnSectionPlane()

New in version NX7.5.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

Validate

TextBuilder.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.