NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Display::SaveImageFileBrowserBuilder Class Reference

Represents a NXOpen::Display::SaveImageFileBrowserBuilder . More...

Inheritance diagram for NXOpen::Display::SaveImageFileBrowserBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  FileFormats { FileFormatsTif, FileFormatsPng, FileFormatsJpg }
 To specify the Ray Traced Studio static image file format. More...
 

Public Member Functions

NXOpen::Display::SaveImageFileBrowserBuilder::FileFormats FileFormat ()
 Returns the Ray Traced Studio static image file format
Created in NX9.0.0. More...
 
NXString NativeImageFileBrowser ()
 Returns the Ray Traced Studio static image file browser
Created in NX9.0.0. More...
 
void SetFileFormat (NXOpen::Display::SaveImageFileBrowserBuilder::FileFormats fileFormat)
 Sets the Ray Traced Studio static image file format
Created in NX9.0.0. More...
 
void SetNativeImageFileBrowser (const NXString &filename)
 Sets the Ray Traced Studio static image file browser
Created in NX9.0.0. More...
 
void SetNativeImageFileBrowser (const char *filename)
 Sets the Ray Traced Studio static image file browser
Created in NX9.0.0. More...
 
void SetUseTransparentBackground (bool useTransparentBackground)
 Sets the Ray Traced Studio static image transparent background setting
Created in NX11.0.1. More...
 
bool UseTransparentBackground ()
 Returns the Ray Traced Studio static image transparent background setting
Created in NX11.0.1. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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 NULL.

To create a new instance of this class, use NXOpen::ViewCollection::CreateSaveImageFileBrowserBuilder

Created in NX9.0.0.

Member Enumeration Documentation

To specify the Ray Traced Studio static image file format.

Enumerator
FileFormatsTif 

Tagged Image File Format (TIFF) file format.

FileFormatsPng 

Portable Network Graphic (PNG) file format.

FileFormatsJpg 

Joint Photographic Experts Group (JPEG) file format.

Member Function Documentation

NXOpen::Display::SaveImageFileBrowserBuilder::FileFormats NXOpen::Display::SaveImageFileBrowserBuilder::FileFormat ( )

Returns the Ray Traced Studio static image file format
Created in NX9.0.0.



License requirements : None

NXString NXOpen::Display::SaveImageFileBrowserBuilder::NativeImageFileBrowser ( )

Returns the Ray Traced Studio static image file browser
Created in NX9.0.0.



License requirements : None

void NXOpen::Display::SaveImageFileBrowserBuilder::SetFileFormat ( NXOpen::Display::SaveImageFileBrowserBuilder::FileFormats  fileFormat)

Sets the Ray Traced Studio static image file format
Created in NX9.0.0.



License requirements : None

Parameters
fileFormatfileformat
void NXOpen::Display::SaveImageFileBrowserBuilder::SetNativeImageFileBrowser ( const NXString filename)

Sets the Ray Traced Studio static image file browser
Created in NX9.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::Display::SaveImageFileBrowserBuilder::SetNativeImageFileBrowser ( const char *  filename)

Sets the Ray Traced Studio static image file browser
Created in NX9.0.0.



License requirements : None

Parameters
filenamefilename
void NXOpen::Display::SaveImageFileBrowserBuilder::SetUseTransparentBackground ( bool  useTransparentBackground)

Sets the Ray Traced Studio static image transparent background setting
Created in NX11.0.1.



License requirements : None

Parameters
useTransparentBackgroundusetransparentbackground
bool NXOpen::Display::SaveImageFileBrowserBuilder::UseTransparentBackground ( )

Returns the Ray Traced Studio static image transparent background setting
Created in NX11.0.1.



License requirements : None


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