SaveImageFileBrowserBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SaveImageFileBrowserBuilder Class

class `NXOpen.Display.``SaveImageFileBrowserBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Display.SaveImageFileBrowserBuilder`.

  Saves an image file using a file browser.

  This class is restricted to being called from a program running during an Interactive NX session. If run from a non-interactive session it will return None.

  To create a new instance of this class, use `NXOpen.ViewCollection.CreateSaveImageFileBrowserBuilder()`

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
FileFormat | Returns or sets the Ray Traced Studio static image file format
NativeImageFileBrowser | Returns or sets the Ray Traced Studio static image file browser
Tag | Returns the Tag for this object.
UseTransparentBackground | Returns or sets the Ray Traced Studio static image transparent background setting

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
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.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

SaveImageFileBrowserBuilderFileFormats Enumeration | To specify the Ray Traced Studio static image file format

# Property Detail

## FileFormat

`SaveImageFileBrowserBuilder.``FileFormat`

  Returns or sets the Ray Traced Studio static image file format

  `-------------------------------------`

  Getter Method

  Signature `FileFormat`

  Returns: |
  Return type: | `NXOpen.Display.SaveImageFileBrowserBuilderFileFormats`

  New in version NX9.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FileFormat`

  Parameters: | fileFormat (`NXOpen.Display.SaveImageFileBrowserBuilderFileFormats`) –

  New in version NX9.0.0.

  License requirements: None.

## NativeImageFileBrowser

`SaveImageFileBrowserBuilder.``NativeImageFileBrowser`

  Returns or sets the Ray Traced Studio static image file browser

  `-------------------------------------`

  Getter Method

  Signature `NativeImageFileBrowser`

  Returns: |
  Return type: | str

  New in version NX9.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `NativeImageFileBrowser`

  Parameters: | filename (str) –

  New in version NX9.0.0.

  License requirements: None.

## UseTransparentBackground

`SaveImageFileBrowserBuilder.``UseTransparentBackground`

  Returns or sets the Ray Traced Studio static image transparent background setting

  `-------------------------------------`

  Getter Method

  Signature `UseTransparentBackground`

  Returns: |
  Return type: | bool

  New in version NX11.0.1.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `UseTransparentBackground`

  Parameters: | useTransparentBackground (bool) –

  New in version NX11.0.1.

  License requirements: None.

# Method Detail

## Validate

`SaveImageFileBrowserBuilder.``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.