NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Features.EmbedManagerBuilder Class Reference

Used to manage the interaction to Embed, Replace, Rename and Delete embedded file information in the part file. More...

Inheritance diagram for NXOpen.Features.EmbedManagerBuilder:
NXOpen.Features.FeatureBuilder NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  LocationTypes { OperatingSystem, Teamcenter }
 The option to specify where the file exists. More...
 
enum  TaskTypes { Embed, Replace, Rename, Delete }
 The task to perform on the file. More...
 
enum  UsageAreaTypes { MathWorksheet, ProductTemplateStudio, DesignLogic, General }
 The area in the part file where the file is to be stored. More...
 

Public Member Functions

unsafe int[] GetEmbeddedFile ()
 Get the index of the embedded file to process. More...
 
unsafe string[] GetEmbeddedFileNames ()
 Get the embedded file names. More...
 
unsafe void SetEmbeddedFile (int[] embeddedFileIndex)
 Set the index of the embedded file to process. More...
 
- Public Member Functions inherited from NXOpen.Features.FeatureBuilder
unsafe NXOpen.Features.Feature CommitFeature ()
 Commits the feature parameters and creates the feature More...
 
unsafe NXOpen.Features.Feature GetFeature ()
 Returns the feature currently being edited by this builder. More...
 
unsafe void HideInternalParentFeatureAfterEdit (NXOpen.Features.Feature parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
unsafe void SetParentFeatureInternal (NXOpen.Features.Feature parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited More...
 
unsafe void ShowInternalParentFeatureForEdit (NXOpen.Features.Feature parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
unsafe void UnsetParentFeatureInternal (NXOpen.Features.Feature parentFeature)
 Set the internal parent feature of the feature being edited to external 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.Features.EmbedManagerBuilder.UsageAreaTypes 
Area [get, set]
 Returns or sets the area in the parts file which matches the application usage. More...
 
unsafe string EmbedFileBrowser [get, set]
 Returns or sets the file browser to embed a new file into the part. More...
 
unsafe string EmbedNativeFileBrowser [get, set]
 Returns or sets the native OS file browser to embed a new file into the part. More...
 
unsafe
NXOpen.Features.EmbedManagerBuilder.LocationTypes 
Location [get, set]
 Returns or sets the source location of the file. More...
 
unsafe string NewNameFile [get, set]
 Returns or sets the new name for the embedded file. More...
 
unsafe string ReplaceFileBrowser [get, set]
 Returns or sets the file browser to replace an embedded file into the part. More...
 
unsafe string ReplaceNativeFileBrowser [get, set]
 Returns or sets the native OS file browser to replace an embedded file into the part. More...
 
unsafe
NXOpen.Features.EmbedManagerBuilder.TaskTypes 
Task [get, set]
 Returns or sets the task to be performed. More...
 
- Properties inherited from NXOpen.Features.FeatureBuilder
unsafe bool ParentFeatureInternal [get, set]
 Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal 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

Used to manage the interaction to Embed, Replace, Rename and Delete embedded file information in the part file.

To create a new instance of this class, use NXOpen.Features.FeatureCollection.CreateEmbedManagerBuilder

Default values.

Property Value

Area

MathWorksheet

Location

OperatingSystem

Task

Embed

Created in NX12.0.0

Member Enumeration Documentation

The option to specify where the file exists.

Enumerator
OperatingSystem 

File exists on the native OS.

Teamcenter 

File exists in Teamcenter.

The task to perform on the file.

Enumerator
Embed 

Embed operating system file in part.

Replace 

Replace the existing embedded file.

Rename 

Rename the existing embedded file.

Delete 

Delete the existing embedded file.

The area in the part file where the file is to be stored.

Enumerator
MathWorksheet 

Used by NX Maple and Maple applications.

ProductTemplateStudio 

Used by Product Template Studio applications.

DesignLogic 

Used by Design Logic applications.

General 

Used by Any application.

Member Function Documentation

unsafe int [] NXOpen.Features.EmbedManagerBuilder.GetEmbeddedFile ( )
inline

Get the index of the embedded file to process.

May be multiple when deleting embedded data.

Created in NX12.0.0

License requirements: None.

Returns
Index of embedded file to be processed
unsafe string [] NXOpen.Features.EmbedManagerBuilder.GetEmbeddedFileNames ( )
inline

Get the embedded file names.

The order is consistent with NXOpen.Features.EmbedManagerBuilder.GetEmbeddedFile indices.

Created in NX12.0.0

License requirements: None.

Returns
Embedded file names corresponding to index usage.
unsafe void NXOpen.Features.EmbedManagerBuilder.SetEmbeddedFile ( int[]  embeddedFileIndex)
inline

Set the index of the embedded file to process.

May be multiple when deleting embedded data.

Created in NX12.0.0

License requirements: solid_modeling ("SOLIDS MODELING")

Parameters
embeddedFileIndexIndex of embedded file to process

Property Documentation

unsafe NXOpen.Features.EmbedManagerBuilder.UsageAreaTypes NXOpen.Features.EmbedManagerBuilder.Area
getset

Returns or sets the area in the parts file which matches the application usage.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe string NXOpen.Features.EmbedManagerBuilder.EmbedFileBrowser
getset

Returns or sets the file browser to embed a new file into the part.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe string NXOpen.Features.EmbedManagerBuilder.EmbedNativeFileBrowser
getset

Returns or sets the native OS file browser to embed a new file into the part.

Used when the session is Teamcenter, but the location is NXOpen.Features.EmbedManagerBuilder.LocationTypes.OperatingSystem .

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.Features.EmbedManagerBuilder.LocationTypes NXOpen.Features.EmbedManagerBuilder.Location
getset

Returns or sets the source location of the file.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe string NXOpen.Features.EmbedManagerBuilder.NewNameFile
getset

Returns or sets the new name for the embedded file.

Used when renaming the embedded file storage.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe string NXOpen.Features.EmbedManagerBuilder.ReplaceFileBrowser
getset

Returns or sets the file browser to replace an embedded file into the part.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe string NXOpen.Features.EmbedManagerBuilder.ReplaceNativeFileBrowser
getset

Returns or sets the native OS file browser to replace an embedded file into the part.

Used when the session is Teamcenter, but the location is NXOpen.Features.EmbedManagerBuilder.LocationTypes.OperatingSystem .

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.Features.EmbedManagerBuilder.TaskTypes NXOpen.Features.EmbedManagerBuilder.Task
getset

Returns or sets the task to be performed.

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING")


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.