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

This is the class representing a layout state. More...

Inheritance diagram for NXOpen.CAE.LayoutState:
NXOpen.TaggedObject NXOpen.Utilities.NXRemotableObject IMessageSink

Classes

struct  _ViewportContent
 Represents the content of a viewport
 
struct  ViewportContent
 Represents the content of a viewport More...
 

Public Types

enum  ViewportContentType { Viewport, Page, CurveOperation }
 Viewport content type More...
 

Public Member Functions

unsafe void Export (string filePath)
 Exports the layout state to an external file More...
 
unsafe
NXOpen.CAE.LayoutState.ViewportContent[] 
GetViewportContents ()
 Get the viewport contents. More...
 
unsafe string GetViewportDescription (int viewport)
 Gets the layout information and the datareferences of a given viewport location More...
 
unsafe string GetViewportDescription (NXOpen.CAE.LayoutState.ViewportContent viewportContent)
 Gets the layout information and the datareferences of the given viewport content More...
 
unsafe void Rename (string name)
 Renames the layout state More...
 
unsafe void SetViewportDescription (int viewport, string xmloutput)
 Sets the layout information and the datareferences to a given viewport location 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...
 

Properties

unsafe string Name [get, set]
 Returns or sets the name of the NXOpen.CAE.LayoutState . More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

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

Detailed Description

This is the class representing a layout state.

Not support KF.

Created in NX11.0.0

Member Enumeration Documentation

Viewport content type

Enumerator
Viewport 

viewport content that represents a viewport

Page 

viewport content that represents a page

CurveOperation 

viewport content that represents a curve operation

Member Function Documentation

unsafe void NXOpen.CAE.LayoutState.Export ( string  filePath)
inline

Exports the layout state to an external file

Created in NX11.0.0

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

Parameters
filePath
unsafe NXOpen.CAE.LayoutState.ViewportContent [] NXOpen.CAE.LayoutState.GetViewportContents ( )
inline

Get the viewport contents.

Created in NX1899.0.0

License requirements: nx_masterfem ("Finite Element Modeling")

Returns
unsafe string NXOpen.CAE.LayoutState.GetViewportDescription ( int  viewport)
inline

Gets the layout information and the datareferences of a given viewport location

Created in NX12.0.0

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

Parameters
viewport
Returns
unsafe string NXOpen.CAE.LayoutState.GetViewportDescription ( NXOpen.CAE.LayoutState.ViewportContent  viewportContent)
inline

Gets the layout information and the datareferences of the given viewport content

Created in NX1899.0.0

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

Parameters
viewportContent
Returns
unsafe void NXOpen.CAE.LayoutState.Rename ( string  name)
inline

Renames the layout state

Created in NX11.0.0

Deprecated in NX12.0.0. Use NXOpen.CAE.LayoutState.Name instead.

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

Parameters
name
unsafe void NXOpen.CAE.LayoutState.SetViewportDescription ( int  viewport,
string  xmloutput 
)
inline

Sets the layout information and the datareferences to a given viewport location

Created in NX12.0.0

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

Parameters
viewport
xmloutput

Property Documentation

unsafe string NXOpen.CAE.LayoutState.Name
getset

Returns or sets the name of the NXOpen.CAE.LayoutState .

Created in NX12.0.0

License requirements to get this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")

License requirements to set this property: nx_masterfem ("Finite Element Modeling") OR nx_design_sim ("NX Design Simulation")


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