PartSymbolFolderBuilder Class

class NXOpen.Annotations.PartSymbolFolderBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Annotations.PartSymbolFolderBuilder.

To create a new instance of this class, use NXOpen.Annotations.PartSymbolFolderCollection.CreatePartSymbolFolderBuilder()

New in version NX7.5.0.

Properties

Property	Description
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetChildren	Returns children of current folder
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetCurrentFolder	Returns current folder
GetFolderCount	Returns number of child folders of current folder
GetFolderName	Returns the folder name
GetObject	Returns the object currently being edited by this builder.
GetParent	Returns parent of current folder provided current folder is not root folder
GetPartSymbolCount	Returns number of part symbols of current folder
GetPartSymbols	Returns part symbols of current folder
GetRootFolder	Get the root part symbol folder
IsRootFolder	Checks whether the given folder is root folder or not
SetFolderName	Sets folder name provided current folder is not root folder
SetParent	Sets parent of current folder provided current folder is not root folder
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Method Detail

GetChildren

PartSymbolFolderBuilder.GetChildren

Returns children of current folder

Signature GetChildren()

Returns:array of sub folders Return type:list of NXOpen.Annotations.PartSymbolFolder

New in version NX7.5.0.

License requirements: None.

GetCurrentFolder

PartSymbolFolderBuilder.GetCurrentFolder

Returns current folder

Signature GetCurrentFolder()

Returns:current folder Return type:NXOpen.Annotations.PartSymbolFolder

New in version NX7.5.0.

License requirements: None.

GetFolderCount

PartSymbolFolderBuilder.GetFolderCount

Returns number of child folders of current folder

Signature GetFolderCount()

Returns:number of child folders Return type:int

New in version NX7.5.0.

License requirements: None.

GetFolderName

PartSymbolFolderBuilder.GetFolderName

Returns the folder name

Signature GetFolderName()

Returns:folder name Return type:str

New in version NX7.5.0.

License requirements: None.

GetParent

PartSymbolFolderBuilder.GetParent

Returns parent of current folder provided current folder is not root folder

Signature GetParent()

Returns:parent part symbol folder Return type:NXOpen.Annotations.PartSymbolFolder

New in version NX7.5.0.

License requirements: None.

GetPartSymbolCount

PartSymbolFolderBuilder.GetPartSymbolCount

Returns number of part symbols of current folder

Signature GetPartSymbolCount()

Returns:number of part symbols Return type:int

New in version NX7.5.0.

License requirements: None.

GetPartSymbols

PartSymbolFolderBuilder.GetPartSymbols

Returns part symbols of current folder

Signature GetPartSymbols()

Returns:array of part symbols Return type:list of NXOpen.Annotations.MasterSymbol

New in version NX7.5.0.

License requirements: None.

GetRootFolder

PartSymbolFolderBuilder.GetRootFolder

Get the root part symbol folder

Signature GetRootFolder()

Returns:root part symbol folder Return type:NXOpen.Annotations.PartSymbolFolder

New in version NX7.5.0.

License requirements: None.

IsRootFolder

PartSymbolFolderBuilder.IsRootFolder

Checks whether the given folder is root folder or not

Signature IsRootFolder()

Returns:returns true if root folder Return type:bool

New in version NX7.5.0.

License requirements: None.

SetFolderName

PartSymbolFolderBuilder.SetFolderName

Sets folder name provided current folder is not root folder

Signature SetFolderName(folderName)

Parameters:folderName (str) – folder name

New in version NX7.5.0.

License requirements: drafting (“DRAFTING”)

SetParent

PartSymbolFolderBuilder.SetParent

Sets parent of current folder provided current folder is not root folder

Signature SetParent(parentfolder)

Parameters:parentfolder (NXOpen.Annotations.PartSymbolFolder) – parent part symbol folder

New in version NX7.5.0.

License requirements: drafting (“DRAFTING”)

Validate

PartSymbolFolderBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.