TODO: Add documentation More...

Inheritance diagram for NXOpen.CAE.PostScenarioColorBarsCustomization:

Public Member Functions
unsafe void	DisableFreeText ()
	Disable the user defined free texts field. More...

unsafe void	DisableRecordNameField (string field)
	Disables field. More...

unsafe void	EnableFreeText ()
	Enables the user defined free texts field. More...

unsafe void	EnableRecordNameField (string field)
	Enables field. More...

unsafe string[]	GetFreeTexts ()
	Returns the user defined texts associated to each record. More...

unsafe string	GetName ()
	Returns the name of the visualization. More...

unsafe int	GetNumberOfRecords ()
	Returns the number of records available in the visualization. More...

unsafe string[]	GetRecordNameFields ()
	Returns the field names used to generate the record names. More...

unsafe int	GetSubviewportIndex ()
	Returns the subviewport id of the visualization. More...

unsafe void	ResetRecordNamesToDefault ()
	Resets the record names to defaults. More...

unsafe void	SetFreeText (int recordIndex, string text)
	Set the free text for a certain record index. More...

unsafe void	Update ()
	This commits the changes done to the visualization. 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...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Detailed Description

TODO: Add documentation

To obtain an instance of this class use NXOpen.CAE.PostScenarioVisualizationCustomizationCollection .

Created in NX1847.0.0

Member Function Documentation

unsafe void NXOpen.CAE.PostScenarioColorBarsCustomization.DisableFreeText ( )

inline

Disable the user defined free texts field.

See CAE.PostScenarioColorBarsCustomization.GetFreeTexts and CAE.PostScenarioColorBarsCustomization.SetFreeText for handling the free texts.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe void NXOpen.CAE.PostScenarioColorBarsCustomization.DisableRecordNameField ( string field )

inline

Disables field.

This field will not be used when generating the record names.

See CAE.PostScenarioColorBarsCustomization.GetRecordNameFields for avaialable fields.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

field

unsafe void NXOpen.CAE.PostScenarioColorBarsCustomization.EnableFreeText ( )

inline

Enables the user defined free texts field.

See CAE.PostScenarioColorBarsCustomization.GetFreeTexts and CAE.PostScenarioColorBarsCustomization.SetFreeText for handling the free texts.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe void NXOpen.CAE.PostScenarioColorBarsCustomization.EnableRecordNameField ( string field )

inline

Enables field.

This field will be used to generate the record names.

See CAE.PostScenarioColorBarsCustomization.GetRecordNameFields for avaialable fields.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

field

unsafe string [] NXOpen.CAE.PostScenarioColorBarsCustomization.GetFreeTexts ( )

inline

Returns the user defined texts associated to each record.

The size of this array is equal to the result of CAE.PostScenarioColorBarsCustomization.GetNumberOfRecords .

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns

unsafe string NXOpen.CAE.PostScenarioColorBarsCustomization.GetName ( )

inline

Returns the name of the visualization.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns

Implements NXOpen.CAE.IPostScenarioVisualizationCustomization.

unsafe int NXOpen.CAE.PostScenarioColorBarsCustomization.GetNumberOfRecords ( )

inline

Returns the number of records available in the visualization.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns

unsafe string [] NXOpen.CAE.PostScenarioColorBarsCustomization.GetRecordNameFields ( )

inline

Returns the field names used to generate the record names.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns

unsafe int NXOpen.CAE.PostScenarioColorBarsCustomization.GetSubviewportIndex ( )

inline

Returns the subviewport id of the visualization.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Returns

Implements NXOpen.CAE.IPostScenarioVisualizationCustomization.

unsafe void NXOpen.CAE.PostScenarioColorBarsCustomization.ResetRecordNamesToDefault ( )

inline

Resets the record names to defaults.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

unsafe void NXOpen.CAE.PostScenarioColorBarsCustomization.SetFreeText	(	int	recordIndex,
		string	text
	)

inline

Set the free text for a certain record index.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Parameters

recordIndex
text

unsafe void NXOpen.CAE.PostScenarioColorBarsCustomization.Update ( )

inline

This commits the changes done to the visualization.

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

Implements NXOpen.CAE.IPostScenarioVisualizationCustomization.

The documentation for this class was generated from the following file:

CAE_PostScenarioColorBarsCustomization.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation