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

Represents a NXOpen::Annotations::PartSymbolFolderBuilder . More...

Inheritance diagram for NXOpen::Annotations::PartSymbolFolderBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

std::vector
< NXOpen::Annotations::PartSymbolFolder * > 
GetChildren ()
 Returns children of current folder. More...
 
NXOpen::Annotations::PartSymbolFolderGetCurrentFolder ()
 Returns current folder. More...
 
int GetFolderCount ()
 Returns number of child folders of current folder. More...
 
NXString GetFolderName ()
 Returns the folder name. More...
 
NXOpen::Annotations::PartSymbolFolderGetParent ()
 Returns parent of current folder provided current folder is not root folder. More...
 
int GetPartSymbolCount ()
 Returns number of part symbols of current folder. More...
 
std::vector
< NXOpen::Annotations::MasterSymbol * > 
GetPartSymbols ()
 Returns part symbols of current folder. More...
 
NXOpen::Annotations::PartSymbolFolderGetRootFolder ()
 Get the root part symbol folder. More...
 
bool IsRootFolder ()
 Checks whether the given folder is root folder or not. More...
 
void SetFolderName (const NXString &folderName)
 Sets folder name provided current folder is not root folder
Created in NX7.5.0. More...
 
void SetFolderName (const char *folderName)
 Sets folder name provided current folder is not root folder
Created in NX7.5.0. More...
 
void SetParent (NXOpen::Annotations::PartSymbolFolder *parentfolder)
 Sets parent of current folder provided current folder is not root folder
Created in NX7.5.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::Annotations::PartSymbolFolderBuilder .


To create a new instance of this class, use NXOpen::Annotations::PartSymbolFolderCollection::CreatePartSymbolFolderBuilder

Created in NX7.5.0.

Member Function Documentation

std::vector<NXOpen::Annotations::PartSymbolFolder *> NXOpen::Annotations::PartSymbolFolderBuilder::GetChildren ( )

Returns children of current folder.

Returns
array of sub folders
Created in NX7.5.0.

License requirements : None
NXOpen::Annotations::PartSymbolFolder* NXOpen::Annotations::PartSymbolFolderBuilder::GetCurrentFolder ( )

Returns current folder.

Returns
current folder
Created in NX7.5.0.

License requirements : None
int NXOpen::Annotations::PartSymbolFolderBuilder::GetFolderCount ( )

Returns number of child folders of current folder.

Returns
number of child folders
Created in NX7.5.0.

License requirements : None
NXString NXOpen::Annotations::PartSymbolFolderBuilder::GetFolderName ( )

Returns the folder name.

Returns
folder name
Created in NX7.5.0.

License requirements : None
NXOpen::Annotations::PartSymbolFolder* NXOpen::Annotations::PartSymbolFolderBuilder::GetParent ( )

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

Returns
parent part symbol folder
Created in NX7.5.0.

License requirements : None
int NXOpen::Annotations::PartSymbolFolderBuilder::GetPartSymbolCount ( )

Returns number of part symbols of current folder.

Returns
number of part symbols
Created in NX7.5.0.

License requirements : None
std::vector<NXOpen::Annotations::MasterSymbol *> NXOpen::Annotations::PartSymbolFolderBuilder::GetPartSymbols ( )

Returns part symbols of current folder.

Returns
array of part symbols
Created in NX7.5.0.

License requirements : None
NXOpen::Annotations::PartSymbolFolder* NXOpen::Annotations::PartSymbolFolderBuilder::GetRootFolder ( )

Get the root part symbol folder.

Returns
root part symbol folder
Created in NX7.5.0.

License requirements : None
bool NXOpen::Annotations::PartSymbolFolderBuilder::IsRootFolder ( )

Checks whether the given folder is root folder or not.

Returns
returns true if root folder
Created in NX7.5.0.

License requirements : None
void NXOpen::Annotations::PartSymbolFolderBuilder::SetFolderName ( const NXString folderName)

Sets folder name provided current folder is not root folder
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
folderNamefolder name
void NXOpen::Annotations::PartSymbolFolderBuilder::SetFolderName ( const char *  folderName)

Sets folder name provided current folder is not root folder
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
folderNamefolder name
void NXOpen::Annotations::PartSymbolFolderBuilder::SetParent ( NXOpen::Annotations::PartSymbolFolder parentfolder)

Sets parent of current folder provided current folder is not root folder
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
parentfolderparent part symbol folder

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