NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | List of all members
NXOpen.CAE.PostLegend Class Reference

This class has the information related to post legend. More...

Inheritance diagram for NXOpen.CAE.PostLegend:
NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Member Functions

unsafe NXOpen.CAE.PostColorbar GetColorbar ()
 Gets the colorbar object More...
 
unsafe bool GetColorbarVisibility ()
 Gets the colorbar visibility state More...
 
unsafe NXOpen.CAE.PostHeader GetHeader ()
 Gets the header object More...
 
unsafe bool GetHeaderVisibility ()
 Gets the header visibility state More...
 
unsafe void SetColorbar (NXOpen.CAE.PostColorbar colorbar)
 Sets the colorbar object More...
 
unsafe void SetColorbarVisibility (bool status)
 Sets the colorbar visibility state More...
 
unsafe void SetHeader (NXOpen.CAE.PostHeader header)
 Sets the header object More...
 
unsafe void SetHeaderVisibility (bool status)
 Sets the header visibility state More...
 
- Public Member Functions inherited from NXOpen.TransientObject
void Dispose ()
 Frees the object from memory. More...
 
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
new 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...
 

Protected Member Functions

override void FreeResource ()
 Destroys the Legend object More...
 

Additional Inherited Members

- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 

Detailed Description

This class has the information related to post legend.

This is a placeholder of the whole legend which includes header and colorbar.

An instance of this class can not be created. To obtain the object use NXOpen.CAE.Post.PostviewGetLegend method.

Created in NX1847.0.0

Member Function Documentation

override void NXOpen.CAE.PostLegend.FreeResource ( )
inlineprotectedvirtual

Destroys the Legend object

Created in NX1847.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe NXOpen.CAE.PostColorbar NXOpen.CAE.PostLegend.GetColorbar ( )
inline

Gets the colorbar object

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Returns
unsafe bool NXOpen.CAE.PostLegend.GetColorbarVisibility ( )
inline

Gets the colorbar visibility state

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Returns
unsafe NXOpen.CAE.PostHeader NXOpen.CAE.PostLegend.GetHeader ( )
inline

Gets the header object

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Returns
unsafe bool NXOpen.CAE.PostLegend.GetHeaderVisibility ( )
inline

Gets the header visibility state

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Returns
unsafe void NXOpen.CAE.PostLegend.SetColorbar ( NXOpen.CAE.PostColorbar  colorbar)
inline

Sets the colorbar object

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
colorbar
unsafe void NXOpen.CAE.PostLegend.SetColorbarVisibility ( bool  status)
inline

Sets the colorbar visibility state

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
status
unsafe void NXOpen.CAE.PostLegend.SetHeader ( NXOpen.CAE.PostHeader  header)
inline

Sets the header object

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
header
unsafe void NXOpen.CAE.PostLegend.SetHeaderVisibility ( bool  status)
inline

Sets the header visibility state

Created in NX1847.0.0

License requirements: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation") OR sc_results_viewer (" Simcenter Results Viewer")

Parameters
status

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