NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.Annotations.CustomSymbolCollection Class Reference

Represents a collection of NXOpen.Annotations.BaseCustomSymbol objects More...

Inheritance diagram for NXOpen.Annotations.CustomSymbolCollection:
NXOpen.TaggedObjectCollection NXOpen.Utilities.NXRemotableObject IEnumerable IMessageSink

Public Member Functions

unsafe
NXOpen.Annotations.CustomSymbol 
CreateCustomSymbol (NXOpen.Annotations.CustomSymbolData customSymbolData, NXOpen.Point3d origin, NXOpen.Annotations.LeaderBundle leader)
 Creates a custom symbol More...
 
unsafe
NXOpen.Annotations.DraftingCustomSymbolBuilder 
CreateDraftingCustomSymbolBuilder (NXOpen.Annotations.CustomSymbol symbolTag)
 Creates the Drafting Symbol placement builder More...
 
unsafe
NXOpen.Annotations.MasterSymbolBuilder 
CreateMasterSymbolBuilder (NXOpen.Annotations.MasterSymbol masterSymbolTag)
 Creates the Master Symbol builder More...
 
unsafe
NXOpen.Annotations.MasterSymbolListItemBuilder 
CreateMasterSymbolListItemBuilder ()
 Creates the Master Symbol List Item builder More...
 
unsafe
NXOpen.Annotations.PmiCustomSymbol 
CreatePmiCustomSymbol (NXOpen.Annotations.CustomSymbolData customSymbolData, NXOpen.Annotations.PmiData pmiData, NXOpen.Xform annotationPlane, NXOpen.Point3d origin, NXOpen.Annotations.LeaderBundle leader)
 Creates a PMI custom symbol More...
 
unsafe
NXOpen.Annotations.PmiCustomSymbolBuilder 
CreatePmiCustomSymbolBuilder (NXOpen.Annotations.PmiCustomSymbol symbolTag)
 Creates the PMI Symbol Placement builder More...
 
unsafe
NXOpen.Annotations.ReplaceSymbolBuilder 
CreateReplaceSymbolBuilder ()
 Creates a NXOpen.Annotations.ReplaceSymbolBuilder More...
 
unsafe
NXOpen.Annotations.SmashCustomSymbolBuilder 
CreateSmashCustomSymbolBuilder ()
 Smashes a custom symbol More...
 
unsafe
NXOpen.Annotations.SymbolCatalogBuilder 
CreateSymbolCatalogBuilder ()
 Creates a symbol catalog dialog builder More...
 
unsafe
NXOpen.Annotations.EditSymbolDisplayBuilder 
EditSymbolDisplayBuilder (NXOpen.Annotations.BaseCustomSymbol symbolTag)
 Creates a edit custom symbol dialog builder More...
 
unsafe
NXOpen.Annotations.MasterSymbol 
FindObject (string name)
 Finds the NXOpen.Annotations.MasterSymbol with the given name. More...
 
unsafe
NXOpen.Annotations.CustomSymbolData 
NewCustomSymbolData (string masterFileName)
 Creates new CustomSymbolData object More...
 
unsafe
NXOpen.Annotations.CustomSymbolData 
NewPartSymbolData (string partSymbolName)
 Creates new CustomSymbolData object to create a part symbol instance. More...
 
NXOpen.Annotations.BaseCustomSymbol[] ToArray ()
 Returns an array of NXOpen.Annotations.BaseCustomSymbol objects. More...
 
- Public Member Functions inherited from NXOpen.TaggedObjectCollection
IEnumerator GetEnumerator ()
 Returns an enumerator that iterates through a collection. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 
- Protected Member Functions inherited from NXOpen.TaggedObjectCollection
new void initialize ()
 <exclude> More...
 
- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 

Properties

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

Detailed Description

Represents a collection of NXOpen.Annotations.BaseCustomSymbol objects

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

Created in NX4.0.0

Member Function Documentation

unsafe NXOpen.Annotations.CustomSymbol NXOpen.Annotations.CustomSymbolCollection.CreateCustomSymbol ( NXOpen.Annotations.CustomSymbolData  customSymbolData,
NXOpen.Point3d  origin,
NXOpen.Annotations.LeaderBundle  leader 
)
inline

Creates a custom symbol

Created in NX4.0.0

Deprecated in NX9.0.0. Use NXOpen.Annotations.DraftingCustomSymbolBuilder instead.

License requirements: drafting ("DRAFTING")

Parameters
customSymbolData
originOrigin for the custom symbol
leaderSpecifies the leaders for the custom symbol
Returns
New custom symbol
unsafe NXOpen.Annotations.DraftingCustomSymbolBuilder NXOpen.Annotations.CustomSymbolCollection.CreateDraftingCustomSymbolBuilder ( NXOpen.Annotations.CustomSymbol  symbolTag)
inline

Creates the Drafting Symbol placement builder

Created in NX7.5.0

License requirements: None.

Parameters
symbolTagSymbol as input
Returns
DraftingCustomSymbolBuilder object
unsafe NXOpen.Annotations.MasterSymbolBuilder NXOpen.Annotations.CustomSymbolCollection.CreateMasterSymbolBuilder ( NXOpen.Annotations.MasterSymbol  masterSymbolTag)
inline

Creates the Master Symbol builder

Created in NX7.5.0

License requirements: None.

Parameters
masterSymbolTagNXOpen.Annotations.MasterSymbol to be set as master symbol
Returns
MasterSymbolBuilder object
unsafe NXOpen.Annotations.MasterSymbolListItemBuilder NXOpen.Annotations.CustomSymbolCollection.CreateMasterSymbolListItemBuilder ( )
inline

Creates the Master Symbol List Item builder

Created in NX7.5.0

License requirements: None.

Returns
CustomSymbolListItemBuilder object
unsafe NXOpen.Annotations.PmiCustomSymbol NXOpen.Annotations.CustomSymbolCollection.CreatePmiCustomSymbol ( NXOpen.Annotations.CustomSymbolData  customSymbolData,
NXOpen.Annotations.PmiData  pmiData,
NXOpen.Xform  annotationPlane,
NXOpen.Point3d  origin,
NXOpen.Annotations.LeaderBundle  leader 
)
inline

Creates a PMI custom symbol

Created in NX4.0.0

Deprecated in NX9.0.0. Use NXOpen.Annotations.PmiCustomSymbolBuilder instead.

License requirements: geometric_tol ("GDT")

Parameters
customSymbolData
pmiDataPMI data
annotationPlaneAnnotation plane on which the custom symbol lies
originOrigin for the custom symbol
leaderSpecifies the leaders for the custom symbol
Returns
New PMI custom symbol
unsafe NXOpen.Annotations.PmiCustomSymbolBuilder NXOpen.Annotations.CustomSymbolCollection.CreatePmiCustomSymbolBuilder ( NXOpen.Annotations.PmiCustomSymbol  symbolTag)
inline

Creates the PMI Symbol Placement builder

Created in NX7.5.0

License requirements: None.

Parameters
symbolTagSymbol as input
Returns
PMICustomSymbolBuilder object
unsafe NXOpen.Annotations.ReplaceSymbolBuilder NXOpen.Annotations.CustomSymbolCollection.CreateReplaceSymbolBuilder ( )
inline

Creates a NXOpen.Annotations.ReplaceSymbolBuilder

Created in NX8.0.1

License requirements: drafting ("DRAFTING")

Returns
unsafe NXOpen.Annotations.SmashCustomSymbolBuilder NXOpen.Annotations.CustomSymbolCollection.CreateSmashCustomSymbolBuilder ( )
inline

Smashes a custom symbol

Created in NX6.0.0

License requirements: None.

Returns
unsafe NXOpen.Annotations.SymbolCatalogBuilder NXOpen.Annotations.CustomSymbolCollection.CreateSymbolCatalogBuilder ( )
inline

Creates a symbol catalog dialog builder

Created in NX8.0.0

License requirements: nx_layout ("NX Layout")

Returns
unsafe NXOpen.Annotations.EditSymbolDisplayBuilder NXOpen.Annotations.CustomSymbolCollection.EditSymbolDisplayBuilder ( NXOpen.Annotations.BaseCustomSymbol  symbolTag)
inline

Creates a edit custom symbol dialog builder

Created in NX7.5.0

License requirements: None.

Parameters
symbolTagSymbol as input
Returns
override int NXOpen.Annotations.CustomSymbolCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
inlineprotectedvirtual

Advances the enumerator to the next element of the collection.

Implements NXOpen.TaggedObjectCollection.

unsafe NXOpen.Annotations.MasterSymbol NXOpen.Annotations.CustomSymbolCollection.FindObject ( string  name)
inline

Finds the NXOpen.Annotations.MasterSymbol with the given name.

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

Created in NX7.5.0

License requirements: None.

Parameters
nameMaster custom symbol name
Returns
Master custom symbol object
unsafe NXOpen.Annotations.CustomSymbolData NXOpen.Annotations.CustomSymbolCollection.NewCustomSymbolData ( string  masterFileName)
inline

Creates new CustomSymbolData object

Created in NX4.0.0

Deprecated in NX9.0.0. Use NXOpen.Annotations.DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen.Annotations.PmiCustomSymbolBuilder for PMI Custom Symbol objects.

License requirements: None.

Parameters
masterFileNameAbsolute path of the master symbol(with .sym.prt extension)
Returns
New CustomSymbolData
unsafe NXOpen.Annotations.CustomSymbolData NXOpen.Annotations.CustomSymbolCollection.NewPartSymbolData ( string  partSymbolName)
inline

Creates new CustomSymbolData object to create a part symbol instance.

Created in NX4.0.0

Deprecated in NX9.0.0. Use NXOpen.Annotations.DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen.Annotations.PmiCustomSymbolBuilder for PMI Custom Symbol objects.

License requirements: None.

Parameters
partSymbolNamePart symbol name. Part symbol is a master symbol that is created and instantiated in the same part.
Returns
New CustomSymbolData
NXOpen.Annotations.BaseCustomSymbol [] NXOpen.Annotations.CustomSymbolCollection.ToArray ( )
inline

Returns an array of NXOpen.Annotations.BaseCustomSymbol objects.

Property Documentation

Tag NXOpen.Annotations.CustomSymbolCollection.Tag
get

Returns the tag of this object.


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