Builder class for Branch Path Numbering. More...

Inheritance diagram for NXOpen.Routing.BranchPathNumberingBuilder:

Public Types
enum	Sequence { Numbers, UpperCase, LowerCase }
	Specifies the sequence method More...

Public Member Functions
unsafe void	SetControlPoint (NXOpen.Routing.ControlPoint controlPoint)
	Set the control point for the start of the labeling sequence More...

unsafe void	SetControlPointFromSegment (NXOpen.Routing.ISegment controlPoint)
	Set the control point for the start of the labeling sequence More...

Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject	Commit ()
	Commits any edits that have been applied to the builder. More...

unsafe void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

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

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe bool	DisplayOnSegments `[get, set]`
	Returns or sets the toggle specified in the UI on whether to display the labels More...

unsafe string	FirstBranchID `[get, set]`
	Returns or sets the formula specified in the UI to compute the first branch ID for the labeling sequence in order to be valid, the formula must be blank OR contain the phrase "PARENT_BRANCH_ID" More...

unsafe string	NextBranchID `[get, set]`
	Returns or sets the formula specified in the UI to compute the next branch ID for the labeling sequence in order to be valid, the formula must be blank OR contain the phrase "PREVIOUS_BRANCH_ID" More...

unsafe string	Prefix `[get, set]`
	Returns or sets the prefix specified in the UI for the labels More...

unsafe bool	ReassignOnSegments `[get, set]`
	Returns or sets the toggle specified in the UI on whether to reassign the labels More...

unsafe NXOpen.Routing.BranchPathNumberingBuilder.Sequence	SequenceMethod `[get, set]`
	Returns or sets the sequence method specified in the UI for the labels More...

unsafe string	StartValue `[get, set]`
	Returns or sets the start value specified in the UI for the labeling sequence More...

unsafe string	StartValueForLowerCase `[get, set]`
	Returns or sets the start value for lower case alphabet. More...

unsafe string	StartValueForNumbers `[get, set]`
	Returns or sets the start value for numbers. More...

unsafe string	StartValueForUpperCase `[get, set]`
	Returns or sets the start value for upper case alphabet. More...

unsafe string	Suffix `[get, set]`
	Returns or sets the suffix specified in the UI for the labels More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Builder class for Branch Path Numbering.

To create a new instance of this class, use NXOpen.Routing.RouteManager.CreateBranchPathNumberingBuilder

Created in NX8.5.0

Member Enumeration Documentation

enum NXOpen.Routing.BranchPathNumberingBuilder.Sequence

Specifies the sequence method

Enumerator
Numbers	1, 2, 3, and so on
UpperCase	A, B, C, and so on
LowerCase	a, b, c, and so on

Member Function Documentation

unsafe void NXOpen.Routing.BranchPathNumberingBuilder.SetControlPoint ( NXOpen.Routing.ControlPoint controlPoint )

inline

Set the control point for the start of the labeling sequence

Created in NX8.5.1

License requirements: routing_hvac ("Routing HVAC")

Parameters

controlPoint

unsafe void NXOpen.Routing.BranchPathNumberingBuilder.SetControlPointFromSegment ( NXOpen.Routing.ISegment controlPoint )

inline

Set the control point for the start of the labeling sequence

Created in NX8.5.1

License requirements: routing_hvac ("Routing HVAC")

Parameters

controlPoint

Property Documentation

unsafe bool NXOpen.Routing.BranchPathNumberingBuilder.DisplayOnSegments

getset

Returns or sets the toggle specified in the UI on whether to display the labels

Created in NX8.5.1

License requirements to get this property: routing_hvac ("Routing HVAC")

License requirements to set this property: routing_hvac ("Routing HVAC")

unsafe string NXOpen.Routing.BranchPathNumberingBuilder.FirstBranchID

getset

Returns or sets the formula specified in the UI to compute the first branch ID for the labeling sequence in order to be valid, the formula must be blank OR contain the phrase "PARENT_BRANCH_ID"

Created in NX8.5.1

License requirements to get this property: routing_hvac ("Routing HVAC")

License requirements to set this property: routing_hvac ("Routing HVAC")

unsafe string NXOpen.Routing.BranchPathNumberingBuilder.NextBranchID

getset

Returns or sets the formula specified in the UI to compute the next branch ID for the labeling sequence in order to be valid, the formula must be blank OR contain the phrase "PREVIOUS_BRANCH_ID"

Created in NX8.5.1

License requirements to get this property: routing_hvac ("Routing HVAC")

License requirements to set this property: routing_hvac ("Routing HVAC")

unsafe string NXOpen.Routing.BranchPathNumberingBuilder.Prefix

getset

Returns or sets the prefix specified in the UI for the labels

Created in NX8.5.1

License requirements to get this property: routing_hvac ("Routing HVAC")

License requirements to set this property: routing_hvac ("Routing HVAC")

unsafe bool NXOpen.Routing.BranchPathNumberingBuilder.ReassignOnSegments

getset

Returns or sets the toggle specified in the UI on whether to reassign the labels

Created in NX8.5.1

License requirements to get this property: routing_hvac ("Routing HVAC")

License requirements to set this property: routing_hvac ("Routing HVAC")

unsafe NXOpen.Routing.BranchPathNumberingBuilder.Sequence NXOpen.Routing.BranchPathNumberingBuilder.SequenceMethod

getset

Returns or sets the sequence method specified in the UI for the labels

Created in NX8.5.1

License requirements to get this property: routing_hvac ("Routing HVAC")

License requirements to set this property: routing_hvac ("Routing HVAC")

unsafe string NXOpen.Routing.BranchPathNumberingBuilder.StartValue

getset

Returns or sets the start value specified in the UI for the labeling sequence

Created in NX8.5.1

Deprecated in NX8.5.2. Use Routing.BranchPathNumberingBuilder.StartValueForNumbers , Routing.BranchPathNumberingBuilder.StartValueForUpperCase , or Routing.BranchPathNumberingBuilder.StartValueForLowerCase instead.

License requirements to get this property: routing_hvac ("Routing HVAC")

License requirements to set this property: routing_hvac ("Routing HVAC")

unsafe string NXOpen.Routing.BranchPathNumberingBuilder.StartValueForLowerCase

getset

Returns or sets the start value for lower case alphabet.

The default value is "a" if the customer does not call this method

Created in NX8.5.1

License requirements to get this property: routing_hvac ("Routing HVAC")

License requirements to set this property: routing_hvac ("Routing HVAC")

unsafe string NXOpen.Routing.BranchPathNumberingBuilder.StartValueForNumbers

getset

Returns or sets the start value for numbers.

The default value is "1" if the customer does not call this method

Created in NX8.5.1

License requirements to get this property: routing_hvac ("Routing HVAC")

License requirements to set this property: routing_hvac ("Routing HVAC")

unsafe string NXOpen.Routing.BranchPathNumberingBuilder.StartValueForUpperCase

getset

Returns or sets the start value for upper case alphabet.

The default value is "A" if the customer does not call this method

Created in NX8.5.1

License requirements to get this property: routing_hvac ("Routing HVAC")

License requirements to set this property: routing_hvac ("Routing HVAC")

unsafe string NXOpen.Routing.BranchPathNumberingBuilder.Suffix

getset

Returns or sets the suffix specified in the UI for the labels

Created in NX8.5.1

License requirements to get this property: routing_hvac ("Routing HVAC")

License requirements to set this property: routing_hvac ("Routing HVAC")

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

Routing_BranchPathNumberingBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation