NXOpen .NET Reference  12.0.0
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.Layout2d.ComponentDefinitionCollection Class Reference

Represents a collection of NXOpen.Layout2d.ComponentDefinition objects. More...

Inheritance diagram for NXOpen.Layout2d.ComponentDefinitionCollection:

Public Member Functions

NXOpen.Layout2d.LocalDefinitionFolder[] ToArray ()
 Returns an array of NXOpen.Layout2d.LocalDefinitionFolder objects. More...
 
unsafe
NXOpen.Layout2d.ComponentDefinition 
FindObject (string sid)
 Finds the NXOpen.Layout2d.ComponentDefinition with the given sid. More...
 
unsafe void Rename (NXOpen.Layout2d.Layout2dDefinitionLocation location, string definitionPath, string newName)
 Renames definition More...
 
unsafe void Delete (NXOpen.Layout2d.Layout2dDefinitionLocation location, string definitionPath)
 Deletes definition More...
 
unsafe void UpdateImage (NXOpen.Layout2d.Layout2dDefinitionLocation location, string definitionPath, string imagePath)
 Updates definition preview More...
 
unsafe void SetAutomaticPreview (NXOpen.Layout2d.Layout2dDefinitionLocation location, string definitionPath, bool isAutomatic)
 Sets the automatic preview mode of definition with the given path More...
 
unsafe void Update (NXOpen.Layout2d.Layout2dDefinitionLocation location, string definitionPath)
 Updates definition with the given path More...
 
unsafe void RefreshAllReferences ()
 Refreshes all definition references in part to obtain the actual out-of-date status of components 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...
 

Detailed Description

Represents a collection of NXOpen.Layout2d.ComponentDefinition objects.

To obtain an instance of this class, refer to NXOpen.Part

Created in NX10.0.0

Member Function Documentation

unsafe void NXOpen.Layout2d.ComponentDefinitionCollection.Delete ( NXOpen.Layout2d.Layout2dDefinitionLocation  location,
string  definitionPath 
)

Deletes definition

Created in NX11.0.0

License requirements: nx_layout ("NX Layout")

Parameters
locationLocation of the definition to delete
definitionPathPath of the definition to delete
override int NXOpen.Layout2d.ComponentDefinitionCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
protected

Advances the enumerator to the next element of the collection.

unsafe NXOpen.Layout2d.ComponentDefinition NXOpen.Layout2d.ComponentDefinitionCollection.FindObject ( string  sid)

Finds the NXOpen.Layout2d.ComponentDefinition with the given sid.

An exception will be thrown if no object can be found with the given sid. This method can only be used to find Local definitions

Created in NX11.0.0

License requirements: nx_layout ("NX Layout")

Parameters
sidThe sid of the definition to find
Returns
unsafe void NXOpen.Layout2d.ComponentDefinitionCollection.RefreshAllReferences ( )

Refreshes all definition references in part to obtain the actual out-of-date status of components

Created in NX12.0.0

License requirements: nx_layout ("NX Layout")

unsafe void NXOpen.Layout2d.ComponentDefinitionCollection.Rename ( NXOpen.Layout2d.Layout2dDefinitionLocation  location,
string  definitionPath,
string  newName 
)

Renames definition

Created in NX11.0.0

License requirements: nx_layout ("NX Layout")

Parameters
locationLocation of the definition to rename
definitionPathPath of the definition to rename
newNameNew definition name
unsafe void NXOpen.Layout2d.ComponentDefinitionCollection.SetAutomaticPreview ( NXOpen.Layout2d.Layout2dDefinitionLocation  location,
string  definitionPath,
bool  isAutomatic 
)

Sets the automatic preview mode of definition with the given path

Created in NX11.0.0

License requirements: nx_layout ("NX Layout")

Parameters
locationLocation of the definition to set the preview mode
definitionPathPath of the definition to set the preview mode
isAutomatic
NXOpen.Layout2d.LocalDefinitionFolder [] NXOpen.Layout2d.ComponentDefinitionCollection.ToArray ( )

Returns an array of NXOpen.Layout2d.LocalDefinitionFolder objects.

unsafe void NXOpen.Layout2d.ComponentDefinitionCollection.Update ( NXOpen.Layout2d.Layout2dDefinitionLocation  location,
string  definitionPath 
)

Updates definition with the given path

Created in NX11.0.0

License requirements: nx_layout ("NX Layout")

Parameters
locationLocation of the definition to update
definitionPathPath of the definition to update
unsafe void NXOpen.Layout2d.ComponentDefinitionCollection.UpdateImage ( NXOpen.Layout2d.Layout2dDefinitionLocation  location,
string  definitionPath,
string  imagePath 
)

Updates definition preview

Created in NX11.0.0

License requirements: nx_layout ("NX Layout")

Parameters
locationLocation of the definition to update image
definitionPathPath of the definition to update image
imagePathPath of the image file used to update definition preview

Property Documentation

Tag NXOpen.Layout2d.ComponentDefinitionCollection.Tag
get

Returns the tag of this object.


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