This builder is used to publish Technical Data Package, or TDP for short. More...

Inheritance diagram for NXOpen.TDP.PublisherBuilder:

Public Types
enum	ModelAccuracyType { Maximum, High, Medium, Low }
	This enum indicates the level of accuracy for publishing a 3D PDF TDP. More...

enum	PublishResult { Success, SuccessWithInconsistency, SuccessWithError, Fail }
	This enum indicates the results of publishing the TDP. More...

enum	ViewSelectionType { SelectedViews, AllDisclosedViews, AllUserDefinedViews, AllViews }
	This enum indicates how the views are selected for publishing TDP. More...

Public Member Functions
unsafe void	AddAttachment (string filename)
	This method adds the new attachment filename to the end of the attachment list. More...

unsafe void	DeleteAttachmentAtIndices (int[] indices)
	This method deletes the attachment filenames at the indicated indices and re-populate the attachment filename list with new continuous indices. More...

unsafe void	GetAttachments (out string[] attachments)
	This method returns the list of attachment filenames More...

unsafe void	GetTextLabels (out string[] labels)
	This method returns the list of text labels. More...

unsafe bool	GetTextValueOfLabel (string label, out string value)
	This method returns the value of the text with the given label, if the text exists. More...

unsafe string	GetWorkTemplateFilename ()
	This method returns the name of the template file that is being worked on. More...

unsafe bool	HasTextOfLabel (string label)
	This method checks to see if a text with the given label exists for the selected template. More...

unsafe NXOpen.TDP.PublisherBuilder.PublishResult	Publish ()
	This method publishes the TDP with builder's data. More...

unsafe void	SetPassword (string password)
	This method sets the password. More...

unsafe bool	SetTextValueOfLabel (string label, string value)
	This method sets the value of the text with the given label, if the text exists. More...

unsafe void	SetWorkTemplateFile (string templateFilename)
	This method sets the template to publish TDP and repopulates the text table. 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 NXOpen.NXColor	BackgroundColor `[get, set]`
	Returns or sets the Background color, if the template to be published is a 3D PDF template More...

unsafe bool	Compression `[get, set]`
	Returns or sets the flag whether to use lossy compression for 3D PDF model, if the template to be published is a 3D PDF template More...

unsafe NXOpen.TDP.PublisherBuilder.ModelAccuracyType	ModelAccuracy `[get, set]`
	Returns or sets the 3D PDF model accuracy, if the template to be published is a 3D PDF template More...

unsafe string	OutputFilename `[get, set]`
	Returns or sets the output filename for the TDP More...

unsafe bool	OverrideColors `[get, set]`
	Returns or sets the flag whether to override ViewPort Background and PMI color, in case of publishing to 3D PDF More...

unsafe NXOpen.NXColor	PmiColor `[get, set]`
	Returns or sets the PMI color, if the template to be published is a 3D PDF template More...

unsafe NXOpen.SelectViewList	SelectedViews `[get]`
	Returns the selected views to publish TDP for, if the view selection method is set to NXOpen.TDP.PublisherBuilder.ViewSelectionType.SelectedViews More...

unsafe bool	UsePassword `[get, set]`
	Returns or sets the flag whether to use password or not More...

unsafe NXOpen.TDP.PublisherBuilder.ViewSelectionType	ViewSelection `[get, set]`
	Returns or sets the view selection method 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

This builder is used to publish Technical Data Package, or TDP for short.

It collects all the necessary inputs from a TDP template and other user options before publishing TDP.

To create a new instance of this class, use NXOpen.TDP.Manager.CreateTdpPublisherBuilder

Created in NX1847.0.0

Member Enumeration Documentation

enum NXOpen.TDP.PublisherBuilder.ModelAccuracyType

This enum indicates the level of accuracy for publishing a 3D PDF TDP.

Enumerator
Maximum
High
Medium
Low

enum NXOpen.TDP.PublisherBuilder.PublishResult

This enum indicates the results of publishing the TDP.

Enumerator
Success
SuccessWithInconsistency
SuccessWithError
Fail

enum NXOpen.TDP.PublisherBuilder.ViewSelectionType

This enum indicates how the views are selected for publishing TDP.

Enumerator
SelectedViews
AllDisclosedViews
AllUserDefinedViews
AllViews

Member Function Documentation

unsafe void NXOpen.TDP.PublisherBuilder.AddAttachment ( string filename )

inline

This method adds the new attachment filename to the end of the attachment list.

Created in NX1847.0.0

License requirements: None.

Parameters

filename

unsafe void NXOpen.TDP.PublisherBuilder.DeleteAttachmentAtIndices ( int[] indices )

inline

This method deletes the attachment filenames at the indicated indices and re-populate the attachment filename list with new continuous indices.

Created in NX1847.0.0

License requirements: None.

Parameters

indices

unsafe void NXOpen.TDP.PublisherBuilder.GetAttachments ( out string[] attachments )

inline

This method returns the list of attachment filenames

Created in NX1847.0.0

License requirements: None.

Parameters

attachments

unsafe void NXOpen.TDP.PublisherBuilder.GetTextLabels ( out string[] labels )

inline

This method returns the list of text labels.

Created in NX1847.0.0

License requirements: None.

Parameters

labels

unsafe bool NXOpen.TDP.PublisherBuilder.GetTextValueOfLabel	(	string	label,
		out string	value
	)

inline

This method returns the value of the text with the given label, if the text exists.

Created in NX1847.0.0

License requirements: None.

Parameters

label
value

Returns

unsafe string NXOpen.TDP.PublisherBuilder.GetWorkTemplateFilename ( )

inline

This method returns the name of the template file that is being worked on.

Created in NX1847.0.0

License requirements: None.

Returns

unsafe bool NXOpen.TDP.PublisherBuilder.HasTextOfLabel ( string label )

inline

This method checks to see if a text with the given label exists for the selected template.

Created in NX1847.0.0

License requirements: None.

Parameters

label

Returns

unsafe NXOpen.TDP.PublisherBuilder.PublishResult NXOpen.TDP.PublisherBuilder.Publish ( )

inline

This method publishes the TDP with builder's data.

Created in NX1847.0.0

License requirements: nx_tdp (" NX Technical Data Package")

Returns

unsafe void NXOpen.TDP.PublisherBuilder.SetPassword ( string password )

inline

This method sets the password.

Created in NX1847.0.0

License requirements: None.

Parameters

password

unsafe bool NXOpen.TDP.PublisherBuilder.SetTextValueOfLabel	(	string	label,
		string	value
	)

inline

This method sets the value of the text with the given label, if the text exists.

Created in NX1847.0.0

License requirements: None.

Parameters

label
value

Returns

unsafe void NXOpen.TDP.PublisherBuilder.SetWorkTemplateFile ( string templateFilename )

inline

This method sets the template to publish TDP and repopulates the text table.

Created in NX1847.0.0

License requirements: None.

Parameters

templateFilename

Property Documentation

unsafe NXOpen.NXColor NXOpen.TDP.PublisherBuilder.BackgroundColor

getset

Returns or sets the Background color, if the template to be published is a 3D PDF template

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.TDP.PublisherBuilder.Compression

getset

Returns or sets the flag whether to use lossy compression for 3D PDF model, if the template to be published is a 3D PDF template

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.TDP.PublisherBuilder.ModelAccuracyType NXOpen.TDP.PublisherBuilder.ModelAccuracy

getset

Returns or sets the 3D PDF model accuracy, if the template to be published is a 3D PDF template

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.TDP.PublisherBuilder.OutputFilename

getset

Returns or sets the output filename for the TDP

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.TDP.PublisherBuilder.OverrideColors

getset

Returns or sets the flag whether to override ViewPort Background and PMI color, in case of publishing to 3D PDF

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.NXColor NXOpen.TDP.PublisherBuilder.PmiColor

getset

Returns or sets the PMI color, if the template to be published is a 3D PDF template

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.SelectViewList NXOpen.TDP.PublisherBuilder.SelectedViews

get

Returns the selected views to publish TDP for, if the view selection method is set to NXOpen.TDP.PublisherBuilder.ViewSelectionType.SelectedViews

Created in NX1847.0.0

License requirements: None.

unsafe bool NXOpen.TDP.PublisherBuilder.UsePassword

getset

Returns or sets the flag whether to use password or not

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.TDP.PublisherBuilder.ViewSelectionType NXOpen.TDP.PublisherBuilder.ViewSelection

getset

Returns or sets the view selection method

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

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

TDP_PublisherBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation