NXOpen::Annotations::HoleTableSettingsLabelBuilder Class Reference

Represents a Annotations::HoleTableSettingsLabelBuilder
Created in NX9.0.0. More...

Inheritance diagram for NXOpen::Annotations::HoleTableSettingsLabelBuilder:

Public Types
enum	IndexType { IndexTypeHoleTypeSymbolAndNumber, IndexTypeNumber, IndexTypeLetterAndNumber }
	Represents Index Options. More...
enum	RelativeLocationType {   RelativeLocationTypeTopLeft, RelativeLocationTypeTopMiddle, RelativeLocationTypeTopRight, RelativeLocationTypeCenterLeft,   RelativeLocationTypeCenter, RelativeLocationTypeCenterRight, RelativeLocationTypeBottomLeft, RelativeLocationTypeBottomMiddle,   RelativeLocationTypeBottomRight }
	Represents Relative Location Options. More...

Public Member Functions
NXString	CharactersToSkip ()
	Returns the characters to skip Created in NX9.0.0.
NXOpen::Annotations::HoleTableSettingsLabelBuilder::IndexType	IndexFormat ()
	Returns the index format of hole label Created in NX9.0.0.
NXOpen::Annotations::HoleTableSettingsLabelBuilder::RelativeLocationType	RelativeLocation ()
	Returns the relative location of hole label Created in NX9.0.0.
void	SetCharactersToSkip (const NXString &charactersToSkip)
	Sets the characters to skip Created in NX9.0.0.
void	SetCharactersToSkip (const char *charactersToSkip)
	Sets the characters to skip Created in NX9.0.0.
void	SetIndexFormat (NXOpen::Annotations::HoleTableSettingsLabelBuilder::IndexType indexFormat)
	Sets the index format of hole label Created in NX9.0.0.
void	SetRelativeLocation (NXOpen::Annotations::HoleTableSettingsLabelBuilder::RelativeLocationType relativeLocation)
	Sets the relative location of hole label Created in NX9.0.0.
void	SetShowLabelWithLeader (bool showLabelWithLeader)
	Sets the show hole label with leader Created in NX9.0.0.
bool	ShowLabelWithLeader ()
	Returns the show hole label with leader Created in NX9.0.0.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Annotations::HoleTableSettingsLabelBuilder
Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::HoleTableSettingsLabelBuilder::IndexType

Represents Index Options.

Enumerator:

IndexTypeHoleTypeSymbolAndNumber	Hole Type Symbol and Number.
IndexTypeNumber	Number.
IndexTypeLetterAndNumber	Letter and Number.

enum NXOpen::Annotations::HoleTableSettingsLabelBuilder::RelativeLocationType

Represents Relative Location Options.

Enumerator:

RelativeLocationTypeTopLeft	Top Left.
RelativeLocationTypeTopMiddle	Top Middle.
RelativeLocationTypeTopRight	Top Right.
RelativeLocationTypeCenterLeft	Center Left.
RelativeLocationTypeCenter	Center.
RelativeLocationTypeCenterRight	Center Right.
RelativeLocationTypeBottomLeft	Bottom Left.
RelativeLocationTypeBottomMiddle	Bottom Middle.
RelativeLocationTypeBottomRight	Bottom Right.

Member Function Documentation

NXString NXOpen::Annotations::HoleTableSettingsLabelBuilder::CharactersToSkip

(

)

Returns the characters to skip
Created in NX9.0.0.

License requirements : None

NXOpen::Annotations::HoleTableSettingsLabelBuilder::IndexType NXOpen::Annotations::HoleTableSettingsLabelBuilder::IndexFormat

(

)

Returns the index format of hole label
Created in NX9.0.0.

License requirements : None

NXOpen::Annotations::HoleTableSettingsLabelBuilder::RelativeLocationType NXOpen::Annotations::HoleTableSettingsLabelBuilder::RelativeLocation

(

)

Returns the relative location of hole label
Created in NX9.0.0.

License requirements : None

void NXOpen::Annotations::HoleTableSettingsLabelBuilder::SetCharactersToSkip

(

const NXString &

charactersToSkip

)

Sets the characters to skip
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

charactersToSkip

characterstoskip

void NXOpen::Annotations::HoleTableSettingsLabelBuilder::SetCharactersToSkip

(

const char *

charactersToSkip

)

Sets the characters to skip
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

charactersToSkip

characterstoskip

void NXOpen::Annotations::HoleTableSettingsLabelBuilder::SetIndexFormat

(

NXOpen::Annotations::HoleTableSettingsLabelBuilder::IndexType

indexFormat

)

Sets the index format of hole label
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

indexFormat

indexformat

void NXOpen::Annotations::HoleTableSettingsLabelBuilder::SetRelativeLocation

(

NXOpen::Annotations::HoleTableSettingsLabelBuilder::RelativeLocationType

relativeLocation

)

Sets the relative location of hole label
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

relativeLocation

relativelocation

void NXOpen::Annotations::HoleTableSettingsLabelBuilder::SetShowLabelWithLeader

(

bool

showLabelWithLeader

)

Sets the show hole label with leader
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

showLabelWithLeader

showlabelwithleader

bool NXOpen::Annotations::HoleTableSettingsLabelBuilder::ShowLabelWithLeader

(

)

Returns the show hole label with leader
Created in NX9.0.0.

License requirements : None

virtual bool NXOpen::Annotations::HoleTableSettingsLabelBuilder::Validate ( )

virtual

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.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

---

The documentation for this class was generated from the following file:

• Annotations_HoleTableSettingsLabelBuilder.hxx