Represents a AutomaticTableBuilder. More...

Inheritance diagram for NXOpen.PID.AutomaticTableBuilder:

Public Types
enum	ObjectTypeOption { Equipment, InlineEquipment, Run, PipeStock }
	Represents the object type. More...

enum	ScopeTypeOption { CurrentSheet, OtherSheet, System }
	Represents the scope type. More...

enum	StockOption { Pipe, Instrumentation }
	Represents the stock type. More...

Public Member Functions
unsafe int	GetNumberOfPropertyCellRanges ()
	Gets the number of property cell ranges. More...

unsafe NXOpen.PID.PropertyCellRangeBuilder	GetPropertyCellRange (int index)
	Gets the property cell range at the given index. More...

unsafe void	InsertPropertyCellRanges (int index, NXOpen.PID.PropertyType[] propertyTypes, string[] propertyKeys)
	Inserts the given number of property cell ranges at the given index. More...

unsafe void	RemovePropertyCellRanges (int index, int number)
	Removes the given number of property cell ranges starting with the given index. 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	ManualUpdate `[get, set]`
	Returns or sets the manual update flag. More...

unsafe NXOpen.PID.AutomaticTableBuilder.ObjectTypeOption	ObjectType `[get, set]`
	Returns or sets the object type. More...

unsafe bool	OutputControlLoop `[get, set]`
	Returns or sets the option to output the control loop list. More...

unsafe bool	OutputEquipment `[get, set]`
	Returns or sets the option to output the equipment list. More...

unsafe bool	OutputInlineEquipmentValve `[get, set]`
	Returns or sets the option to output the inline equipment/valve list. More...

unsafe bool	OutputInstrumentation `[get, set]`
	Returns or sets the option to output the instrumentation list. More...

unsafe bool	OutputRun `[get, set]`
	Returns or sets the option to output the run list. More...

unsafe NXOpen.PID.AutomaticTableBuilder.ScopeTypeOption	ScopeType `[get, set]`
	Returns or sets the scope type. More...

unsafe NXOpen.PID.Sheet	Sheet `[get, set]`
	Returns or sets the sheet, only available if the ScopeType is OtherSheet. More...

unsafe NXOpen.PID.AutomaticTableBuilder.StockOption	StockType `[get, set]`
	Returns or sets the stock type to output. More...

unsafe NXOpen.Assemblies.Partition	System `[get, set]`
	Returns or sets the system, only available if the ScopeType is System. More...

unsafe NXOpen.Diagramming.Tables.TableBuilder	Table `[get, set]`
	Returns or sets the NXOpen.Diagramming.Tables.TableBuilder of the NXOpen.Diagramming.Tables.Table . 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

Represents a AutomaticTableBuilder.

To create a new instance of this class, use NXOpen.PID.PidManager.CreateAutomaticTableBuilder

Default values.

Property

Value

ScopeType

CurrentSheet

StockType

Pipe

Created in NX1847.0.0

Member Enumeration Documentation

enum NXOpen.PID.AutomaticTableBuilder.ObjectTypeOption

Represents the object type.

Enumerator
Equipment	Equipment
InlineEquipment	Inline quipment, deprecated from nx1872 and combined with NXOpen.PID.AutomaticTableBuilder.ObjectTypeOption.Equipment .
Run	Run
PipeStock	Pipe Stock

enum NXOpen.PID.AutomaticTableBuilder.ScopeTypeOption

Represents the scope type.

Enumerator
CurrentSheet	Lists objects in current sheet
OtherSheet	Lists objects in other sheet
System	Lists objects in specific system

enum NXOpen.PID.AutomaticTableBuilder.StockOption

Represents the stock type.

Enumerator
Pipe	Pipe Stock
Instrumentation	Instrumentation Line Stock

Member Function Documentation

unsafe int NXOpen.PID.AutomaticTableBuilder.GetNumberOfPropertyCellRanges ( )

inline

Gets the number of property cell ranges.

Created in NX1847.0.0

License requirements: None.

Returns: the number of property cell ranges

unsafe NXOpen.PID.PropertyCellRangeBuilder NXOpen.PID.AutomaticTableBuilder.GetPropertyCellRange ( int index )

inline

Gets the property cell range at the given index.

The index must be greater than or equal to 0, and less than the number of property cell ranges.

Created in NX1847.0.0

License requirements: None.

Parameters

index the index of property cell range

Returns

unsafe void NXOpen.PID.AutomaticTableBuilder.InsertPropertyCellRanges	(	int	index,
		NXOpen.PID.PropertyType[]	propertyTypes,
		string[]	propertyKeys
	)

inline

Inserts the given number of property cell ranges at the given index.

The index must be greater than or equal to 0, and less than or equal to the number of property cell ranges. The number of property types and the number of property keys must be same, and must be greater than 0.

Created in NX1847.0.0

License requirements: nx_pid_design_author ("NX P and ID Design Author")

Parameters

index	the index of the first inserted property cell range
propertyTypes	the property types of inserted property cell ranges
propertyKeys	the property keys of inserted property cell ranges

unsafe void NXOpen.PID.AutomaticTableBuilder.RemovePropertyCellRanges	(	int	index,
		int	number
	)

inline

Removes the given number of property cell ranges starting with the given index.

The index must be greater than or equal to 0, and less than the number of property cell ranges. The number must be greater than 0, and "index + number" must be less than or equal to the number of property cell ranges.

Created in NX1847.0.0

License requirements: nx_pid_design_author ("NX P and ID Design Author")

Parameters

index	the index of the first removed property cell range
number	the number of removed property cell ranges

Property Documentation

unsafe bool NXOpen.PID.AutomaticTableBuilder.ManualUpdate

getset

Returns or sets the manual update flag.

If true, the automatic update will be disabled, the table could be updated manually.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe NXOpen.PID.AutomaticTableBuilder.ObjectTypeOption NXOpen.PID.AutomaticTableBuilder.ObjectType

getset

Returns or sets the object type.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe bool NXOpen.PID.AutomaticTableBuilder.OutputControlLoop

getset

Returns or sets the option to output the control loop list.

Only applicable when NXOpen.PID.AutomaticTableBuilder.ScopeType is NXOpen.PID.AutomaticTableBuilder.ObjectTypeOption.Run .

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe bool NXOpen.PID.AutomaticTableBuilder.OutputEquipment

getset

Returns or sets the option to output the equipment list.

Only applicable when NXOpen.PID.AutomaticTableBuilder.ScopeType is NXOpen.PID.AutomaticTableBuilder.ObjectTypeOption.Equipment .

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe bool NXOpen.PID.AutomaticTableBuilder.OutputInlineEquipmentValve

getset

Returns or sets the option to output the inline equipment/valve list.

Only applicable when NXOpen.PID.AutomaticTableBuilder.ScopeType is NXOpen.PID.AutomaticTableBuilder.ObjectTypeOption.Equipment .

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe bool NXOpen.PID.AutomaticTableBuilder.OutputInstrumentation

getset

Returns or sets the option to output the instrumentation list.

Only applicable when NXOpen.PID.AutomaticTableBuilder.ScopeType is NXOpen.PID.AutomaticTableBuilder.ObjectTypeOption.Equipment .

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe bool NXOpen.PID.AutomaticTableBuilder.OutputRun

getset

Returns or sets the option to output the run list.

Only applicable when NXOpen.PID.AutomaticTableBuilder.ScopeType is NXOpen.PID.AutomaticTableBuilder.ObjectTypeOption.Run .

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe NXOpen.PID.AutomaticTableBuilder.ScopeTypeOption NXOpen.PID.AutomaticTableBuilder.ScopeType

getset

Returns or sets the scope type.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe NXOpen.PID.Sheet NXOpen.PID.AutomaticTableBuilder.Sheet

getset

Returns or sets the sheet, only available if the ScopeType is OtherSheet.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe NXOpen.PID.AutomaticTableBuilder.StockOption NXOpen.PID.AutomaticTableBuilder.StockType

getset

Returns or sets the stock type to output.

Only applicable when NXOpen.PID.AutomaticTableBuilder.ScopeType is NXOpen.PID.AutomaticTableBuilder.ObjectTypeOption.PipeStock .

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe NXOpen.Assemblies.Partition NXOpen.PID.AutomaticTableBuilder.System

getset

Returns or sets the system, only available if the ScopeType is System.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe NXOpen.Diagramming.Tables.TableBuilder NXOpen.PID.AutomaticTableBuilder.Table

getset

Returns or sets the NXOpen.Diagramming.Tables.TableBuilder of the NXOpen.Diagramming.Tables.Table .

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

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

PID_AutomaticTableBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation