NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::PreviewPropertiesBuilder Class Reference

Represents a PreviewPropertiesBuilder to be used for creating and storing previews. More...

Inheritance diagram for NXOpen::PreviewPropertiesBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  ModelViewCreationOptions { ModelViewCreationOptionsOnPartSave, ModelViewCreationOptionsOnViewSave, ModelViewCreationOptionsOnDemand }
 Specifies when the model view preview will be created. More...
enum  PartCreationOptions { PartCreationOptionsOnSave, PartCreationOptionsOnDemand }
 Specifies when the part preview will be created. More...

Public Member Functions

NXOpen::PreviewPropertiesBuilder::ModelViewCreationOptions ModelViewCreation ()
 Returns the model view creation.
NXOpen::PreviewPropertiesBuilder::PartCreationOptions PartCreation ()
 Returns the part creation.
NXOpen::SelectNXObjectListSelectedObjects ()
 Returns the selected object(s) list.
void SetModelViewCreation (NXOpen::PreviewPropertiesBuilder::ModelViewCreationOptions modelViewCreation)
 Sets the model view creation.
void SetPartCreation (NXOpen::PreviewPropertiesBuilder::PartCreationOptions partCreation)
 Sets the part creation.
void SetStoreModelViewPreview (bool storeModelViewPreview)
 Sets the store model view preview.
void SetStorePartPreview (bool storePartPreview)
 Sets the store part preview.
bool StoreModelViewPreview ()
 Returns the store model view preview.
bool StorePartPreview ()
 Returns the store part preview.

Detailed Description

Represents a PreviewPropertiesBuilder to be used for creating and storing previews.

Both part previews and model view previews are supported.
To create a new instance of this class, use PropertiesManager::CreatePreviewPropertiesBuilder
Default values.

Property Value

ModelViewCreation

OnPartSave

PartCreation

OnSave

StoreModelViewPreview

0

StorePartPreview

0


Created in NX8.0.0.


Member Enumeration Documentation

Specifies when the model view preview will be created.

Enumerator:
ModelViewCreationOptionsOnPartSave 

Model view preview will be created when the part is saved.

ModelViewCreationOptionsOnViewSave 

Model view preview will be created when the view is saved.

ModelViewCreationOptionsOnDemand 

Interactive only option that allows the model view preview to be created by selected the Create Now button.

Specifies when the part preview will be created.

Enumerator:
PartCreationOptionsOnSave 

Part preview will be created when the part is saved.

PartCreationOptionsOnDemand 

Interactive only option that allows the part preview to be created by selecting the Create Now button.


Member Function Documentation

Returns the model view creation.

This option determines when the model view preview will be stored. It is only used if the store model view preview is turned on.
Created in NX8.0.0.

License requirements : None

Returns the part creation.

This option determines when the part preview will be stored. It is only used if the store part preview is turned on.
Created in NX8.0.0.

License requirements : None

Returns the selected object(s) list.


Created in NX8.0.0.

License requirements : None

Sets the model view creation.

This option determines when the model view preview will be stored. It is only used if the store model view preview is turned on.
Created in NX8.0.0.

License requirements : None

Parameters:
modelViewCreationmodelviewcreation

Sets the part creation.

This option determines when the part preview will be stored. It is only used if the store part preview is turned on.
Created in NX8.0.0.

License requirements : None

Parameters:
partCreationpartcreation
void NXOpen::PreviewPropertiesBuilder::SetStoreModelViewPreview ( bool  storeModelViewPreview)

Sets the store model view preview.

Determines if the model view preview will be stored. If true, the model view creation option will decide when the preview will be stored.
Created in NX8.0.0.

License requirements : None

Parameters:
storeModelViewPreviewstoremodelviewpreview

Sets the store part preview.

Determines if the part preview will be stored. If true, the part creation option will decide when the preview will be stored.
Created in NX8.0.0.

License requirements : None

Parameters:
storePartPreviewstorepartpreview

Returns the store model view preview.

Determines if the model view preview will be stored. If true, the model view creation option will decide when the preview will be stored.
Created in NX8.0.0.

License requirements : None

Returns the store part preview.

Determines if the part preview will be stored. If true, the part creation option will decide when the preview will be stored.
Created in NX8.0.0.

License requirements : None


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