FrameBarElementStyleBuilder Class¶
-
class
NXOpen.Annotations.
FrameBarElementStyleBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a
NXOpen.Annotations.FrameBarElementStyleBuilder
.This class queries and sets FrameBar preferences when creating and editing FrameBar drafting annotations.
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
ExtendedTicBegin | Returns or sets the extended tic from which display to be started |
ExtendedTicColor | Returns or sets the extended tic color |
ExtendedTicFont | Returns or sets the extended tic font |
ExtendedTicFrequency | Returns or sets the extended tic display frequency |
ExtendedTicLength | Returns or sets the extended tic length |
ExtendedTicWidth | Returns or sets the extended tic width |
LabelColor | Returns or sets the label color |
LabelFont | Returns or sets the label font |
LabelItalicized | Returns or sets the label font style |
LabelName | Returns or sets the label name |
LabelWidth | Returns or sets the label width |
SkipLabelBegin | Returns or sets the label from which skip to be started |
SkipLabelFrequency | Returns or sets the label skip frequency |
SkipTicBegin | Returns or sets the tic from which skip to be started |
SkipTicFrequency | Returns or sets the tic skip frequency |
Tag | Returns the Tag for this object. |
TicColor | Returns or sets the tic color |
TicDisplay | Returns or sets the transverse frames tic display type |
TicFont | Returns or sets the tic font |
TicLabelTextOrientation | Returns or sets the tic label text orientation type |
TicLength | Returns or sets the tic length |
TicWidth | Returns or sets the tic width |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
FrameBarElementStyleBuilderLabelTextOrientation Enumeration | the Label text orientation |
Property Detail¶
ExtendedTicBegin¶
-
FrameBarElementStyleBuilder.
ExtendedTicBegin
¶ Returns or sets the extended tic from which display to be started
-------------------------------------
Getter Method
Signature
ExtendedTicBegin
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExtendedTicBegin
Parameters: displayExtendBegin (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
ExtendedTicColor¶
-
FrameBarElementStyleBuilder.
ExtendedTicColor
¶ Returns or sets the extended tic color
-------------------------------------
Getter Method
Signature
ExtendedTicColor
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExtendedTicColor
Parameters: extendColor (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
ExtendedTicFont¶
-
FrameBarElementStyleBuilder.
ExtendedTicFont
¶ Returns or sets the extended tic font
-------------------------------------
Getter Method
Signature
ExtendedTicFont
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExtendedTicFont
Parameters: extendFont (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
ExtendedTicFrequency¶
-
FrameBarElementStyleBuilder.
ExtendedTicFrequency
¶ Returns or sets the extended tic display frequency
-------------------------------------
Getter Method
Signature
ExtendedTicFrequency
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExtendedTicFrequency
Parameters: displayExtendFrequency (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
ExtendedTicLength¶
-
FrameBarElementStyleBuilder.
ExtendedTicLength
¶ Returns or sets the extended tic length
-------------------------------------
Getter Method
Signature
ExtendedTicLength
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExtendedTicLength
Parameters: extendLength (float) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
ExtendedTicWidth¶
-
FrameBarElementStyleBuilder.
ExtendedTicWidth
¶ Returns or sets the extended tic width
-------------------------------------
Getter Method
Signature
ExtendedTicWidth
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExtendedTicWidth
Parameters: extendWidth (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
LabelColor¶
-
FrameBarElementStyleBuilder.
LabelColor
¶ Returns or sets the label color
-------------------------------------
Getter Method
Signature
LabelColor
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LabelColor
Parameters: labelColor (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
LabelFont¶
-
FrameBarElementStyleBuilder.
LabelFont
¶ Returns or sets the label font
-------------------------------------
Getter Method
Signature
LabelFont
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LabelFont
Parameters: labelFont (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
LabelItalicized¶
-
FrameBarElementStyleBuilder.
LabelItalicized
¶ Returns or sets the label font style
-------------------------------------
Getter Method
Signature
LabelItalicized
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LabelItalicized
Parameters: italic (bool) – New in version NX8.5.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
LabelName¶
-
FrameBarElementStyleBuilder.
LabelName
¶ Returns or sets the label name
-------------------------------------
Getter Method
Signature
LabelName
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LabelName
Parameters: labelName (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
LabelWidth¶
-
FrameBarElementStyleBuilder.
LabelWidth
¶ Returns or sets the label width
-------------------------------------
Getter Method
Signature
LabelWidth
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LabelWidth
Parameters: labelWidth (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
SkipLabelBegin¶
-
FrameBarElementStyleBuilder.
SkipLabelBegin
¶ Returns or sets the label from which skip to be started
-------------------------------------
Getter Method
Signature
SkipLabelBegin
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SkipLabelBegin
Parameters: skipLabelBegin (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
SkipLabelFrequency¶
-
FrameBarElementStyleBuilder.
SkipLabelFrequency
¶ Returns or sets the label skip frequency
-------------------------------------
Getter Method
Signature
SkipLabelFrequency
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SkipLabelFrequency
Parameters: skipLabelFrequency (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
SkipTicBegin¶
-
FrameBarElementStyleBuilder.
SkipTicBegin
¶ Returns or sets the tic from which skip to be started
-------------------------------------
Getter Method
Signature
SkipTicBegin
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SkipTicBegin
Parameters: skipTicBegin (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
SkipTicFrequency¶
-
FrameBarElementStyleBuilder.
SkipTicFrequency
¶ Returns or sets the tic skip frequency
-------------------------------------
Getter Method
Signature
SkipTicFrequency
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SkipTicFrequency
Parameters: skipTicFrequency (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
TicColor¶
-
FrameBarElementStyleBuilder.
TicColor
¶ Returns or sets the tic color
-------------------------------------
Getter Method
Signature
TicColor
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TicColor
Parameters: ticColor (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
TicDisplay¶
-
FrameBarElementStyleBuilder.
TicDisplay
¶ Returns or sets the transverse frames tic display type
-------------------------------------
Getter Method
Signature
TicDisplay
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TicDisplay
Parameters: ticDisplay (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
TicFont¶
-
FrameBarElementStyleBuilder.
TicFont
¶ Returns or sets the tic font
-------------------------------------
Getter Method
Signature
TicFont
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TicFont
Parameters: ticFont (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
TicLabelTextOrientation¶
-
FrameBarElementStyleBuilder.
TicLabelTextOrientation
¶ Returns or sets the tic label text orientation type
-------------------------------------
Getter Method
Signature
TicLabelTextOrientation
Returns: Return type: NXOpen.Annotations.FrameBarElementStyleBuilderLabelTextOrientation
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TicLabelTextOrientation
Parameters: ticLabelTextOrientation ( NXOpen.Annotations.FrameBarElementStyleBuilderLabelTextOrientation
) –New in version NX11.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
TicLength¶
-
FrameBarElementStyleBuilder.
TicLength
¶ Returns or sets the tic length
-------------------------------------
Getter Method
Signature
TicLength
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TicLength
Parameters: ticLength (float) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
TicWidth¶
-
FrameBarElementStyleBuilder.
TicWidth
¶ Returns or sets the tic width
-------------------------------------
Getter Method
Signature
TicWidth
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TicWidth
Parameters: ticWidth (int) – New in version NX8.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”) OR drafting (“DRAFTING”)
Method Detail¶
Validate¶
-
FrameBarElementStyleBuilder.
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.