Represents a NXOpen.Annotations.HoleCalloutSettingsBuilder , this builder contains list(s) of parameter(s) for feature(s). More...

Inheritance diagram for NXOpen.Annotations.HoleCalloutSettingsBuilder:

Public Types
enum	Featuretype { GeneralHole, DrillSizeHole, ScrewClearanceHole, ThreadedHole, SymbolicThread, None }
	This reprensent the option that indicates a type of hole features. More...

enum	Parametertype { Diameter, Depth, CounterBoreDiameter, CounterBoreDepth, CounterSinkDiameter, CounterSinkAngle, TaperAngle, PatternFeatureCount, ScrewSize, Fit, LineBreak, ThreadSize, ThreadDepth, Pitch, Angle, MinorDiameter, MajorDiameter, TapDrillDiameter, Callout, Length, ShaftSize, None }
	This reprensent the option that indicates a type of hole feature parameters. More...

enum	LeaderAttachment { Top, BelowBottomExtendedToMaximum, BelowTopExtendedToMaximum }
	This reprensent the option that indicates the position for the leader to attach to. More...

Public Member Functions
unsafe NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype[]	GetListOfFeatures ()
	Gets the list of features. More...

unsafe NXOpen.Annotations.HoleCalloutSettingsBuilder.Parametertype[]	GetListOfParameters (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType)
	Gets the list of parameters for feature type. More...

unsafe bool	ReorderParameters (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, NXOpen.Annotations.HoleCalloutSettingsBuilder.Parametertype[] parameters)
	Reorder the parameters based on the input. More...

unsafe void	ShiftUp (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, int nth)
	If the position of the nth hole feature parameter of feature type can be shifted up, shifts it up by one. More...

unsafe void	ShiftDown (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, int nth)
	If the position of the nth hole feature parameter of feature type can be shifted down, shifts it down by one. More...

unsafe void	InsertLineBreak (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, int nth)
	If a line break can be inserted immediately after the nth hole feature parameter of feature type, inserts a line break at that position. More...

unsafe void	DeleteLineBreak (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, int nth)
	If the nth hole feature parameter of feature type is a line break and it can be deleted, deletes it. More...

unsafe bool	GetNthParameterDisplay (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, int nth)
	Gets the display status of the nth hole feature parameter of feature type. More...

unsafe void	SetNthParameterDisplay (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, int nth, bool parameterDisplay)
	Sets the display status of the nth hole feature parameter of feature type. More...

unsafe void	SetNthParameterValue (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, int nth, string value)
	Sets the parameter expression of the nth hole feature parameter of feature type. More...

unsafe string	GetNthParameterValue (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, int nth)
	Gets the parameter expression of the nth hole feature parameter of feature type. More...

unsafe string	GetNthParameterValueString (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, int nth)
	Gets the parameter string representation of the nth hole feature parameter of feature type. More...

unsafe void	SetNthParameterPrefix (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, int nth, string[] lines)
	If the prefix of the nth hole feature parameter of feature type can be edited, sets its prefix. More...

unsafe string[]	GetNthParameterPrefix (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, int nth)
	If the nth hole feature parameter of feature type can have prefix, gets its prefix. More...

unsafe void	SetNthParameterSuffix (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, int nth, string[] lines)
	If the suffix of the nth hole feature parameter of feature type can be edited, sets its suffix. More...

unsafe string[]	GetNthParameterSuffix (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, int nth)
	If the nth hole feature parameter of feature type can have suffix, gets its suffix. More...

unsafe NXOpen.Annotations.StyleBuilder	GetNthParameterStyle (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, int nth)
	Gets the parameter style of the nth hole feature parameter of feature type. More...

unsafe void	ResetFromFeature (NXOpen.Features.Feature feature, NXOpen.Assemblies.Component partOccurrence, NXOpen.View view, NXOpen.Point3d pickPoint)
	Reset the builder data based on a feature if the feature is a hole feature. More...

unsafe double	GetParameterSpaceFactor ()
	Gets the parameter space factor, which defines the horizontal space between parameters. More...

unsafe void	SetParameterSpaceFactor (double parameterSpaceFactor)
	Sets the parameter space factor, which defines the horizontal space between parameters. More...

unsafe double	GetLineSpaceFactor ()
	Gets the line space factor, which defines the vertical space between parameters. More...

unsafe void	SetLineSpaceFactor (double lineSpaceFactor)
	Sets the line space factor, which defines the vertical space between parameters. More...

unsafe NXOpen.Annotations.HoleCalloutSettingsBuilder.LeaderAttachment	GetLeaderAttachment ()
	Gets the leader attachment, which decides where the leader is attached to the call out. More...

unsafe void	SetLeaderAttachment (NXOpen.Annotations.HoleCalloutSettingsBuilder.LeaderAttachment leaderAttachment)
	Sets the leader attachment, which decides where the leader is attached to the call out. More...

unsafe string	GetThroughHoleTextOfType (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType)
	Get Through Hole Text String. More...

unsafe void	SetThroughHoleTextOfType (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType, string throughHoleTextString)
	Set Through Hole Text String. More...

unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Detailed Description

Represents a NXOpen.Annotations.HoleCalloutSettingsBuilder , this builder contains list(s) of parameter(s) for feature(s).

Each feature is categorized under a feature type, indicated by NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype . For each feature, parameter(s) are arranged in an array, with a starting index of zero.

This is a sub-builder class and cannot be directly instantiated

Created in NX9.0.0

Member Enumeration Documentation

enum NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype

This reprensent the option that indicates a type of hole features.

Enumerator
GeneralHole
DrillSizeHole
ScrewClearanceHole
ThreadedHole
SymbolicThread
None

enum NXOpen.Annotations.HoleCalloutSettingsBuilder.LeaderAttachment

This reprensent the option that indicates the position for the leader to attach to.

Enumerator
Top
BelowBottomExtendedToMaximum
BelowTopExtendedToMaximum

enum NXOpen.Annotations.HoleCalloutSettingsBuilder.Parametertype

This reprensent the option that indicates a type of hole feature parameters.

Enumerator
Diameter
Depth
CounterBoreDiameter
CounterBoreDepth
CounterSinkDiameter
CounterSinkAngle
TaperAngle
PatternFeatureCount
ScrewSize
Fit
LineBreak
ThreadSize
ThreadDepth
Pitch
Angle
MinorDiameter
MajorDiameter
TapDrillDiameter
Callout
Length
ShaftSize
None

Member Function Documentation

unsafe void NXOpen.Annotations.HoleCalloutSettingsBuilder.DeleteLineBreak	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		int	nth
	)

If the nth hole feature parameter of feature type is a line break and it can be deleted, deletes it.

To delete the second parameter of feature type NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype.GeneralHole , for instance, use the API: NXOpen.Annotations.HoleCalloutSettingsBuilder.DeleteLineBreak (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype.GeneralHole , 1)

Created in NX9.0.0

License requirements: drafting ("DRAFTING")

Parameters

featureType
nth

unsafe NXOpen.Annotations.HoleCalloutSettingsBuilder.LeaderAttachment NXOpen.Annotations.HoleCalloutSettingsBuilder.GetLeaderAttachment ( )

Gets the leader attachment, which decides where the leader is attached to the call out.

Created in NX9.0.0

License requirements: None.

Returns

unsafe double NXOpen.Annotations.HoleCalloutSettingsBuilder.GetLineSpaceFactor ( )

Gets the line space factor, which defines the vertical space between parameters.

Created in NX9.0.0

License requirements: None.

Returns

unsafe NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype [] NXOpen.Annotations.HoleCalloutSettingsBuilder.GetListOfFeatures ( )

Gets the list of features.

Created in NX9.0.0

License requirements: None.

Returns

unsafe NXOpen.Annotations.HoleCalloutSettingsBuilder.Parametertype [] NXOpen.Annotations.HoleCalloutSettingsBuilder.GetListOfParameters ( NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType )

Gets the list of parameters for feature type.

Created in NX9.0.0

License requirements: None.

Parameters

featureType

Returns

unsafe bool NXOpen.Annotations.HoleCalloutSettingsBuilder.GetNthParameterDisplay	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		int	nth
	)

Gets the display status of the nth hole feature parameter of feature type.

Created in NX9.0.0

License requirements: None.

Parameters

featureType
nth

Returns

unsafe string [] NXOpen.Annotations.HoleCalloutSettingsBuilder.GetNthParameterPrefix	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		int	nth
	)

If the nth hole feature parameter of feature type can have prefix, gets its prefix.

Created in NX9.0.0

License requirements: None.

Parameters

featureType
nth

Returns: List of lines

unsafe NXOpen.Annotations.StyleBuilder NXOpen.Annotations.HoleCalloutSettingsBuilder.GetNthParameterStyle	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		int	nth
	)

Gets the parameter style of the nth hole feature parameter of feature type.

Created in NX9.0.0

License requirements: None.

Parameters

featureType
nth

Returns

unsafe string [] NXOpen.Annotations.HoleCalloutSettingsBuilder.GetNthParameterSuffix	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		int	nth
	)

If the nth hole feature parameter of feature type can have suffix, gets its suffix.

Created in NX9.0.0

License requirements: None.

Parameters

featureType
nth

Returns: List of lines

unsafe string NXOpen.Annotations.HoleCalloutSettingsBuilder.GetNthParameterValue	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		int	nth
	)

Gets the parameter expression of the nth hole feature parameter of feature type.

Created in NX9.0.0

License requirements: None.

Parameters

featureType
nth

Returns

unsafe string NXOpen.Annotations.HoleCalloutSettingsBuilder.GetNthParameterValueString	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		int	nth
	)

Gets the parameter string representation of the nth hole feature parameter of feature type.

Differs from NXOpen.Annotations.HoleCalloutSettingsBuilder.GetNthParameterValue in that certain parameters which do not have a parameter value still have a string representation. This API will return that string representation instead of an empty string.

Created in NX11.0.1

License requirements: None.

Parameters

featureType
nth

Returns

unsafe double NXOpen.Annotations.HoleCalloutSettingsBuilder.GetParameterSpaceFactor ( )

Gets the parameter space factor, which defines the horizontal space between parameters.

Created in NX9.0.0

License requirements: None.

Returns

unsafe string NXOpen.Annotations.HoleCalloutSettingsBuilder.GetThroughHoleTextOfType ( NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype featureType )

Get Through Hole Text String.

Created in NX12.0.0

License requirements: None.

Parameters

featureType

Returns

unsafe void NXOpen.Annotations.HoleCalloutSettingsBuilder.InsertLineBreak	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		int	nth
	)

If a line break can be inserted immediately after the nth hole feature parameter of feature type, inserts a line break at that position.

To insert a line break after the fourth parameter of feature type NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype.GeneralHole , for instance, use the API: NXOpen.Annotations.HoleCalloutSettingsBuilder.InsertLineBreak (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype.GeneralHole , 3)

Created in NX9.0.0

License requirements: drafting ("DRAFTING")

Parameters

featureType
nth

unsafe bool NXOpen.Annotations.HoleCalloutSettingsBuilder.ReorderParameters	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		NXOpen.Annotations.HoleCalloutSettingsBuilder.Parametertype[]	parameters
	)

Reorder the parameters based on the input.

This function only works if all input parameters exist in the builder and all builder parameters exist in the input.

Created in NX9.0.0

License requirements: drafting ("DRAFTING")

Parameters

featureType
parameters

Returns

unsafe void NXOpen.Annotations.HoleCalloutSettingsBuilder.ResetFromFeature	(	NXOpen.Features.Feature	feature,
		NXOpen.Assemblies.Component	partOccurrence,
		NXOpen.View	view,
		NXOpen.Point3d	pickPoint
	)

Reset the builder data based on a feature if the feature is a hole feature.

Created in NX9.0.0

License requirements: drafting ("DRAFTING")

Parameters

feature
partOccurrence
view
pickPoint	selected object point

unsafe void NXOpen.Annotations.HoleCalloutSettingsBuilder.SetLeaderAttachment ( NXOpen.Annotations.HoleCalloutSettingsBuilder.LeaderAttachment leaderAttachment )

Sets the leader attachment, which decides where the leader is attached to the call out.

Created in NX9.0.0

License requirements: drafting ("DRAFTING")

Parameters

leaderAttachment

unsafe void NXOpen.Annotations.HoleCalloutSettingsBuilder.SetLineSpaceFactor ( double lineSpaceFactor )

Sets the line space factor, which defines the vertical space between parameters.

The line space factor cannot be less than zero.

Created in NX9.0.0

License requirements: drafting ("DRAFTING")

Parameters

lineSpaceFactor

unsafe void NXOpen.Annotations.HoleCalloutSettingsBuilder.SetNthParameterDisplay	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		int	nth,
		bool	parameterDisplay
	)

Sets the display status of the nth hole feature parameter of feature type.

Created in NX9.0.0

License requirements: drafting ("DRAFTING")

Parameters

featureType
nth
parameterDisplay

unsafe void NXOpen.Annotations.HoleCalloutSettingsBuilder.SetNthParameterPrefix	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		int	nth,
		string[]	lines
	)

If the prefix of the nth hole feature parameter of feature type can be edited, sets its prefix.

Created in NX9.0.0

License requirements: drafting ("DRAFTING")

Parameters

featureType
nth
lines	List of new lines

unsafe void NXOpen.Annotations.HoleCalloutSettingsBuilder.SetNthParameterSuffix	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		int	nth,
		string[]	lines
	)

If the suffix of the nth hole feature parameter of feature type can be edited, sets its suffix.

Created in NX9.0.0

License requirements: drafting ("DRAFTING")

Parameters

featureType
nth
lines	List of new lines

unsafe void NXOpen.Annotations.HoleCalloutSettingsBuilder.SetNthParameterValue	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		int	nth,
		string	value
	)

Sets the parameter expression of the nth hole feature parameter of feature type.

Created in NX9.0.0

License requirements: None.

Parameters

featureType
nth
value

unsafe void NXOpen.Annotations.HoleCalloutSettingsBuilder.SetParameterSpaceFactor ( double parameterSpaceFactor )

Sets the parameter space factor, which defines the horizontal space between parameters.

The parameter space factor cannot be less than zero.

Created in NX9.0.0

License requirements: drafting ("DRAFTING")

Parameters

parameterSpaceFactor

unsafe void NXOpen.Annotations.HoleCalloutSettingsBuilder.SetThroughHoleTextOfType	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		string	throughHoleTextString
	)

Set Through Hole Text String.

Created in NX12.0.0

License requirements: drafting ("DRAFTING")

Parameters

featureType
throughHoleTextString

unsafe void NXOpen.Annotations.HoleCalloutSettingsBuilder.ShiftDown	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		int	nth
	)

If the position of the nth hole feature parameter of feature type can be shifted down, shifts it down by one.

To shift down the first parameter of feature type NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype.GeneralHole , for instance, use the API: NXOpen.Annotations.HoleCalloutSettingsBuilder.ShiftDown (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype.GeneralHole , 0)

Created in NX9.0.0

License requirements: drafting ("DRAFTING")

Parameters

featureType
nth

unsafe void NXOpen.Annotations.HoleCalloutSettingsBuilder.ShiftUp	(	NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype	featureType,
		int	nth
	)

If the position of the nth hole feature parameter of feature type can be shifted up, shifts it up by one.

To shift up the third parameter of feature type NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype.GeneralHole , for instance, use the API: NXOpen.Annotations.HoleCalloutSettingsBuilder.ShiftUp (NXOpen.Annotations.HoleCalloutSettingsBuilder.Featuretype.GeneralHole , 2)

Created in NX9.0.0

License requirements: drafting ("DRAFTING")

Parameters

featureType
nth

unsafe bool NXOpen.Annotations.HoleCalloutSettingsBuilder.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.

Created in NX3.0.1

License requirements: None.

Returns: Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

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

dotnet_pool/Annotations_HoleCalloutSettingsBuilder.cs

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation