Represents a collection of layouts. More...

Inheritance diagram for NXOpen.LayoutCollection:

Public Member Functions
NXOpen.Layout[]	ToArray ()
	Returns an array of NXOpen.Layout objects. More...

unsafe NXOpen.Layout	Create (string name, NXOpen.LayoutDefinition layoutArrangement, bool fitAllViews)
	Creates a layout using an NXOpen.LayoutDefinition . More...

unsafe void	NewLayoutDefinition (NXOpen.LayoutDefinition.ArrangementType arrangement, out NXOpen.LayoutDefinition layoutArrangement)
	Constructs a NXOpen.LayoutDefinition object to be used to create a layout. More...

unsafe NXOpen.Layout	FindObject (string journalIdentifier)
	Finds the NXOpen.Layout with the given identifier as recorded in a journal. More...

unsafe void	CreateSplitScreenLayoutAndNamedViews (string leftViewName, string rightViewname, out NXOpen.Layout layout, out NXOpen.View leftView, out NXOpen.View rightView)
	This method creates a layout with two modeling views. More...

unsafe void	DestroySplitScreenLayoutAndNamedViews (NXOpen.Layout layout)
	This method destroys the split screen layout along with the views * that are there in it More...

unsafe void	ChangeLayout (NXOpen.Layout layout)
	Sets the given layout as current layout More...

unsafe void	RenameViewsInSplitScreenLayout (NXOpen.Layout layout, string leftViewName, string rightViewName)
	Using given names renames the views in split screen layout. More...

unsafe void	ChangeLayoutWithOptions (NXOpen.Layout layout, bool removeOldLayoutCache, bool ignoreNewLayoutCache)
	Sets the given layout as current layout and optionally removes the old and/or new layout caches More...

Protected Member Functions
override int	EnumerateMoveNext (ref Tag currentTag, byte[] state)
	Advances the enumerator to the next element of the collection. More...

Properties
Tag	Tag `[get]`
	Returns the tag of this object. More...

unsafe NXOpen.Layout	Current `[get]`
	Returns the current layout of the part. 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

unsafe void NXOpen.LayoutCollection.ChangeLayout ( NXOpen.Layout layout )

Sets the given layout as current layout

Created in NX6.0.0

License requirements: None.

Parameters

layout Layout

unsafe void NXOpen.LayoutCollection.ChangeLayoutWithOptions	(	NXOpen.Layout	layout,
		bool	removeOldLayoutCache,
		bool	ignoreNewLayoutCache
	)

Sets the given layout as current layout and optionally removes the old and/or new layout caches

Created in NX11.0.0

License requirements: None.

Parameters

layout	Layout
removeOldLayoutCache	Flag to indicate if the current layout's cache should be removed
ignoreNewLayoutCache	Flag to indicate if the new layout's cache should be used or removed

unsafe NXOpen.Layout NXOpen.LayoutCollection.Create	(	string	name,
		NXOpen.LayoutDefinition	layoutArrangement,
		bool	fitAllViews
	)

Creates a layout using an NXOpen.LayoutDefinition .

Created in NX3.0.0

License requirements: None.

Parameters

name	Name of layout
layoutArrangement	Arrangement and view location information
fitAllViews	Flag 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.

Returns

unsafe void NXOpen.LayoutCollection.CreateSplitScreenLayoutAndNamedViews	(	string	leftViewName,
		string	rightViewname,
		out NXOpen.Layout	layout,
		out NXOpen.View	leftView,
		out 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

leftViewName	name for the left view
rightViewname	name for the right view
layout	Layout
leftView	View
rightView	View

unsafe 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

layout Layout

override int NXOpen.LayoutCollection.EnumerateMoveNext	(	ref Tag	currentTag,
		byte[]	state
	)

protected

Advances the enumerator to the next element of the collection.

unsafe NXOpen.Layout NXOpen.LayoutCollection.FindObject ( string 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.

Created in NX3.0.0

License requirements: None.

Parameters

journalIdentifier Identifier to be found

Returns: Layout found

unsafe void NXOpen.LayoutCollection.NewLayoutDefinition	(	NXOpen.LayoutDefinition.ArrangementType	arrangement,
		out 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

arrangement	Arrangement type
layoutArrangement	Layout arrangement used to create a layout

unsafe void NXOpen.LayoutCollection.RenameViewsInSplitScreenLayout	(	NXOpen.Layout	layout,
		string	leftViewName,
		string	rightViewName
	)

Using given names renames the views in split screen layout.

Created in NX6.0.0

License requirements: None.

Parameters

layout	Layout
leftViewName	name for the left view
rightViewName	name for the right view

NXOpen.Layout [] NXOpen.LayoutCollection.ToArray ( )

Returns an array of NXOpen.Layout objects.

Property Documentation

unsafe NXOpen.Layout NXOpen.LayoutCollection.Current

get

Returns the current layout of the part.

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.

Tag NXOpen.LayoutCollection.Tag

get

Returns the tag of this object.

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

dotnet_pool/LayoutCollection.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation