NX Open C++ Reference Guide
Classes | Public Member Functions | List of all members
NXOpen::LayoutCollection Class Reference

Represents a collection of layouts. More...

Inheritance diagram for NXOpen::LayoutCollection:
NXOpen::TaggedObjectCollection

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element. More...
 
void ChangeLayout (NXOpen::Layout *layout)
 Sets the given layout as current layout
Created in NX6.0.0. More...
 
NXOpen::LayoutCreate (const NXString &name, NXOpen::LayoutDefinition *layoutArrangement, bool fitAllViews)
 Creates a layout using an NXOpen::LayoutDefinition . More...
 
NXOpen::LayoutCreate (const char *name, NXOpen::LayoutDefinition *layoutArrangement, bool fitAllViews)
 Creates a layout using an NXOpen::LayoutDefinition . More...
 
void CreateSplitScreenLayoutAndNamedViews (const NXString &leftViewName, const NXString &rightViewname, NXOpen::Layout **layout, NXOpen::View **leftView, NXOpen::View **rightView)
 This method creates a layout with two modeling views. More...
 
void CreateSplitScreenLayoutAndNamedViews (const char *leftViewName, const char *rightViewname, NXOpen::Layout **layout, NXOpen::View **leftView, NXOpen::View **rightView)
 This method creates a layout with two modeling views. More...
 
NXOpen::LayoutCurrent ()
 Returns the current the layout. More...
 
void DestroySplitScreenLayoutAndNamedViews (NXOpen::Layout *layout)
 This method destroys the split screen layout along with the views that are there in it
Created in NX6.0.0. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::LayoutFindObject (const NXString &journalIdentifier)
 Finds the NXOpen::Layout with the given identifier as recorded in a journal. More...
 
NXOpen::LayoutFindObject (const char *journalIdentifier)
 Finds the NXOpen::Layout with the given identifier as recorded in a journal. More...
 
void NewLayoutDefinition (NXOpen::LayoutDefinition::ArrangementType arrangement, NXOpen::LayoutDefinition **layoutArrangement)
 Constructs a NXOpen::LayoutDefinition object to be used to create a layout. More...
 
void RenameViewsInSplitScreenLayout (NXOpen::Layout *layout, const NXString &leftViewName, const NXString &rightViewName)
 Using given names renames the views in split screen layout. More...
 
void RenameViewsInSplitScreenLayout (NXOpen::Layout *layout, const char *leftViewName, const char *rightViewName)
 Using given names renames the views in split screen layout. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of layouts.


To obtain an instance of this class, refer to NXOpen::BasePart

Created in NX3.0.0.

Member Function Documentation

iterator NXOpen::LayoutCollection::begin ( )

Returns an iterator addressing the first element.

void NXOpen::LayoutCollection::ChangeLayout ( NXOpen::Layout layout)

Sets the given layout as current layout
Created in NX6.0.0.



License requirements : None

Parameters
layoutLayout
NXOpen::Layout* NXOpen::LayoutCollection::Create ( const NXString name,
NXOpen::LayoutDefinition layoutArrangement,
bool  fitAllViews 
)

Creates a layout using an NXOpen::LayoutDefinition .

Returns

Created in NX3.0.0.

License requirements : None
Parameters
nameName of layout
NOTE: The full Unicode character set is not supported for this parameter.
layoutArrangementArrangement and view location information
fitAllViewsFlag that indicates for the system to perform a fit before displaying the view. Otherwise the system displays the view at the scale at which it was last saved.
NXOpen::Layout* NXOpen::LayoutCollection::Create ( const char *  name,
NXOpen::LayoutDefinition layoutArrangement,
bool  fitAllViews 
)

Creates a layout using an NXOpen::LayoutDefinition .

Returns

Created in NX3.0.0.

License requirements : None
Parameters
nameName of layout
NOTE: The full Unicode character set is not supported for this parameter.
layoutArrangementArrangement and view location information
fitAllViewsFlag that indicates for the system to perform a fit before displaying the view. Otherwise the system displays the view at the scale at which it was last saved.
void NXOpen::LayoutCollection::CreateSplitScreenLayoutAndNamedViews ( const NXString leftViewName,
const NXString rightViewname,
NXOpen::Layout **  layout,
NXOpen::View **  leftView,
NXOpen::View **  rightView 
)

This method creates a layout with two modeling views.

The views are created with names given. Layout and view tags are returned
Created in NX6.0.0.

License requirements : None

Parameters
leftViewNamename for the left view
NOTE: The full Unicode character set is not supported for this parameter.
rightViewnamename for the right view
NOTE: The full Unicode character set is not supported for this parameter.
layoutLayout
leftViewView
rightViewView
void NXOpen::LayoutCollection::CreateSplitScreenLayoutAndNamedViews ( const char *  leftViewName,
const char *  rightViewname,
NXOpen::Layout **  layout,
NXOpen::View **  leftView,
NXOpen::View **  rightView 
)

This method creates a layout with two modeling views.

The views are created with names given. Layout and view tags are returned
Created in NX6.0.0.

License requirements : None

Parameters
leftViewNamename for the left view
NOTE: The full Unicode character set is not supported for this parameter.
rightViewnamename for the right view
NOTE: The full Unicode character set is not supported for this parameter.
layoutLayout
leftViewView
rightViewView
NXOpen::Layout* NXOpen::LayoutCollection::Current ( )

Returns the current the layout.

When in the drafting application and a drawing sheet is not displayed, this will return a layout that has limited operations that can be performed on it.


Created in NX3.0.0.

License requirements : None

void NXOpen::LayoutCollection::DestroySplitScreenLayoutAndNamedViews ( NXOpen::Layout layout)

This method destroys the split screen layout along with the views that are there in it
Created in NX6.0.0.



License requirements : None

Parameters
layoutLayout
iterator NXOpen::LayoutCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::Layout* NXOpen::LayoutCollection::FindObject ( const NXString journalIdentifier)

Finds the NXOpen::Layout with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
Layout found
Created in NX3.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier to be found
NXOpen::Layout* NXOpen::LayoutCollection::FindObject ( const char *  journalIdentifier)

Finds the NXOpen::Layout with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
Layout found
Created in NX3.0.0.

License requirements : None
Parameters
journalIdentifierIdentifier to be found
void NXOpen::LayoutCollection::NewLayoutDefinition ( NXOpen::LayoutDefinition::ArrangementType  arrangement,
NXOpen::LayoutDefinition **  layoutArrangement 
)

Constructs a NXOpen::LayoutDefinition object to be used to create a layout.

If a layout is not created using the created definition object, the client is responsible for deleting it.
Created in NX3.0.0.

License requirements : None

Parameters
arrangementArrangement type
layoutArrangementLayout arrangement used to create a layout
void NXOpen::LayoutCollection::RenameViewsInSplitScreenLayout ( NXOpen::Layout layout,
const NXString leftViewName,
const NXString rightViewName 
)

Using given names renames the views in split screen layout.


Created in NX6.0.0.

License requirements : None

Parameters
layoutLayout
leftViewNamename for the left view
NOTE: The full Unicode character set is not supported for this parameter.
rightViewNamename for the right view
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::LayoutCollection::RenameViewsInSplitScreenLayout ( NXOpen::Layout layout,
const char *  leftViewName,
const char *  rightViewName 
)

Using given names renames the views in split screen layout.


Created in NX6.0.0.

License requirements : None

Parameters
layoutLayout
leftViewNamename for the left view
NOTE: The full Unicode character set is not supported for this parameter.
rightViewNamename for the right view
NOTE: The full Unicode character set is not supported for this parameter.
tag_t NXOpen::LayoutCollection::Tag ( ) const

Returns the tag of this object.


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