EmbedManagerBuilder Class¶
-
class
NXOpen.Features.EmbedManagerBuilder¶ Bases:
NXOpen.Features.FeatureBuilderUsed 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 New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| Area | Returns or sets the area in the parts file which matches the application usage. |
| EmbedFileBrowser | Returns or sets the file browser to embed a new file into the part. |
| EmbedNativeFileBrowser | Returns or sets the native OS file browser to embed a new file into the part. |
| Location | Returns or sets the source location of the file. |
| NewNameFile | Returns or sets the new name for the embedded file. |
| ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
| PatchSolutionFlag | Returns or sets the patch solution flag |
| PatchSurfaceFilename | Returns or sets the patch surface filename |
| ReplaceFileBrowser | Returns or sets the file browser to replace an embedded file into the part. |
| ReplaceNativeFileBrowser | Returns or sets the native OS file browser to replace an embedded file into the part. |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
| Task | Returns or sets the task to be performed. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| CommitFeature | Commits the feature parameters and creates the feature |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetEmbeddedFile | Get the index of the embedded file to process. |
| GetEmbeddedFileNames | Get the embedded file names. |
| GetFeature | Returns the feature currently being edited by this builder. |
| GetObject | Returns the object currently being edited by this builder. |
| HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
| SetEmbeddedFile | Set the index of the embedded file to process. |
| SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
| ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| EmbedManagerBuilderLocationTypes Enumeration | The option to specify where the file exists. |
| EmbedManagerBuilderTaskTypes Enumeration | The task to perform on the file. |
| EmbedManagerBuilderUsageAreaTypes Enumeration | The area in the part file where the file is to be stored. |
Property Detail¶
Area¶
-
EmbedManagerBuilder.Area¶ Returns or sets the area in the parts file which matches the application usage.
-------------------------------------Getter Method
Signature
AreaReturns: Return type: NXOpen.Features.EmbedManagerBuilderUsageAreaTypesNew in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AreaParameters: area ( NXOpen.Features.EmbedManagerBuilderUsageAreaTypes) –New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
EmbedFileBrowser¶
-
EmbedManagerBuilder.EmbedFileBrowser¶ Returns or sets the file browser to embed a new file into the part.
-------------------------------------Getter Method
Signature
EmbedFileBrowserReturns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
EmbedFileBrowserParameters: filename (str) – New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
EmbedNativeFileBrowser¶
-
EmbedManagerBuilder.EmbedNativeFileBrowser¶ 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.EmbedManagerBuilderLocationTypes.OperatingSystem.-------------------------------------Getter Method
Signature
EmbedNativeFileBrowserReturns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
EmbedNativeFileBrowserParameters: filename (str) – New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Location¶
-
EmbedManagerBuilder.Location¶ Returns or sets the source location of the file.
-------------------------------------Getter Method
Signature
LocationReturns: Return type: NXOpen.Features.EmbedManagerBuilderLocationTypesNew in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LocationParameters: location ( NXOpen.Features.EmbedManagerBuilderLocationTypes) –New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
NewNameFile¶
-
EmbedManagerBuilder.NewNameFile¶ Returns or sets the new name for the embedded file.
Used when renaming the embedded file storage.
-------------------------------------Getter Method
Signature
NewNameFileReturns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NewNameFileParameters: newNameFile (str) – New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ReplaceFileBrowser¶
-
EmbedManagerBuilder.ReplaceFileBrowser¶ Returns or sets the file browser to replace an embedded file into the part.
-------------------------------------Getter Method
Signature
ReplaceFileBrowserReturns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReplaceFileBrowserParameters: filename (str) – New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ReplaceNativeFileBrowser¶
-
EmbedManagerBuilder.ReplaceNativeFileBrowser¶ 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.EmbedManagerBuilderLocationTypes.OperatingSystem.-------------------------------------Getter Method
Signature
ReplaceNativeFileBrowserReturns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ReplaceNativeFileBrowserParameters: filename (str) – New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Task¶
-
EmbedManagerBuilder.Task¶ Returns or sets the task to be performed.
-------------------------------------Getter Method
Signature
TaskReturns: Return type: NXOpen.Features.EmbedManagerBuilderTaskTypesNew in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TaskParameters: type ( NXOpen.Features.EmbedManagerBuilderTaskTypes) –New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Method Detail¶
GetEmbeddedFile¶
-
EmbedManagerBuilder.GetEmbeddedFile¶ Get the index of the embedded file to process.
May be multiple when deleting embedded data.
Signature
GetEmbeddedFile()Returns: Index of embedded file to be processed Return type: list of int New in version NX12.0.0.
License requirements: None.
GetEmbeddedFileNames¶
-
EmbedManagerBuilder.GetEmbeddedFileNames¶ Get the embedded file names.
The order is consistent with
NXOpen.Features.EmbedManagerBuilder.GetEmbeddedFile()indices.Signature
GetEmbeddedFileNames()Returns: Embedded file names corresponding to index usage. Return type: list of str New in version NX12.0.0.
License requirements: None.
SetEmbeddedFile¶
-
EmbedManagerBuilder.SetEmbeddedFile¶ Set the index of the embedded file to process.
May be multiple when deleting embedded data.
Signature
SetEmbeddedFile(embeddedFileIndex)Parameters: embeddedFileIndex (list of int) – Index of embedded file to process New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Validate¶
-
EmbedManagerBuilder.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.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.