NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Annotations.IdSymbolBuilder Class Reference

Represents a NXOpen.Annotations.IdSymbol builder More...

Inheritance diagram for NXOpen.Annotations.IdSymbolBuilder:
NXOpen.Builder NXOpen.GeometricUtilities.IComponentBuilder

Public Types

enum  SymbolTypes {
  Circle, DividedCircle, Triangle, TriangleUp,
  Square, DividedSquare, Hexagon, DividedHexagon,
  QuadrantCircle, RoundedBox, Underline
}
 the valid types for an id symbol More...
 

Public Member Functions

unsafe void SetPreviewObject (NXOpen.Annotations.IdSymbol symbol)
 Sets the preview object for dialog creation of id symbols More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 

Properties

unsafe
NXOpen.Annotations.ForeshorteningSymbolBuilder 
ForeshorteningSymbol [get]
 Returns the foreshortening symbol builder More...
 
unsafe NXOpen.SelectObject Inherit [get]
 Returns the inherit The id symbol from which the style properties are inherited More...
 
unsafe
NXOpen.Annotations.LeaderBuilder 
Leader [get]
 Returns the NXOpen.Annotations.LeaderBuilder for the annotation More...
 
unsafe string LowerText [get, set]
 Returns or sets the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line. More...
 
unsafe
NXOpen.Annotations.OriginBuilder 
Origin [get]
 Returns the origin, where the symbol is going to be displayed More...
 
unsafe
NXOpen.Annotations.AnnotationPlacement 
Placement [get]
 Returns an annotation placement object More...
 
unsafe double Size [get, set]
 Returns or sets the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle More...
 
unsafe
NXOpen.Annotations.StyleBuilder 
Style [get]
 Returns the style More...
 
unsafe
NXOpen.Annotations.IdSymbolBuilder.SymbolTypes 
SymbolType [get, set]
 Returns or sets the symbol type More...
 
unsafe
NXOpen.Annotations.IdSymbolBuilder.SymbolTypes 
Type [get, set]
 Returns or sets the symbol type More...
 
unsafe string UpperText [get, set]
 Returns or sets the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line. More...
 

Detailed Description

Represents a NXOpen.Annotations.IdSymbol builder

To create a new instance of this class, use NXOpen.Annotations.IdSymbolCollection.CreateIdSymbolBuilder

Default values.

Property Value

Size

0

Created in NX5.0.0

Member Enumeration Documentation

the valid types for an id symbol

Enumerator
Circle 

Circle

DividedCircle 

Divided circle

Triangle 

Triangle with point down

TriangleUp 

Triangle with point up

Square 

Square

DividedSquare 

Divided square

Hexagon 

Hexagon

DividedHexagon 

Divided hexagon

QuadrantCircle 

Quadrant circle

RoundedBox 

Rounded box

Underline 

Underline

Member Function Documentation

unsafe void NXOpen.Annotations.IdSymbolBuilder.SetPreviewObject ( NXOpen.Annotations.IdSymbol  symbol)

Sets the preview object for dialog creation of id symbols

Created in NX5.0.0

Deprecated in NX6.0.0. This functionality is no longer supported.

License requirements: None.

Parameters
symbolrubberbanding symbol

Property Documentation

unsafe NXOpen.Annotations.ForeshorteningSymbolBuilder NXOpen.Annotations.IdSymbolBuilder.ForeshorteningSymbol
get

Returns the foreshortening symbol builder

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.SelectObject NXOpen.Annotations.IdSymbolBuilder.Inherit
get

Returns the inherit The id symbol from which the style properties are inherited

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.Annotations.LeaderBuilder NXOpen.Annotations.IdSymbolBuilder.Leader
get

Returns the NXOpen.Annotations.LeaderBuilder for the annotation

Created in NX6.0.0

License requirements: None.

unsafe string NXOpen.Annotations.IdSymbolBuilder.LowerText
getset

Returns or sets the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: drafting ("DRAFTING") OR geometric_tol ("GDT")

unsafe NXOpen.Annotations.OriginBuilder NXOpen.Annotations.IdSymbolBuilder.Origin
get

Returns the origin, where the symbol is going to be displayed

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Annotations.AnnotationPlacement NXOpen.Annotations.IdSymbolBuilder.Placement
get

Returns an annotation placement object

Created in NX5.0.0

Deprecated in NX6.0.0. This functionality is no longer supported.

License requirements: None.

unsafe double NXOpen.Annotations.IdSymbolBuilder.Size
getset

Returns or sets the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: drafting ("DRAFTING") OR geometric_tol ("GDT")

unsafe NXOpen.Annotations.StyleBuilder NXOpen.Annotations.IdSymbolBuilder.Style
get

Returns the style

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Annotations.IdSymbolBuilder.SymbolTypes NXOpen.Annotations.IdSymbolBuilder.SymbolType
getset

Returns or sets the symbol type

Created in NX5.0.0

Deprecated in NX6.0.0. Use NXOpen.Annotations.IdSymbolBuilder.Type instead.

License requirements to get this property: None.

License requirements to set this property: drafting ("DRAFTING") OR geometric_tol ("GDT")

unsafe NXOpen.Annotations.IdSymbolBuilder.SymbolTypes NXOpen.Annotations.IdSymbolBuilder.Type
getset

Returns or sets the symbol type

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: drafting ("DRAFTING") OR geometric_tol ("GDT")

unsafe string NXOpen.Annotations.IdSymbolBuilder.UpperText
getset

Returns or sets the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: drafting ("DRAFTING") OR geometric_tol ("GDT")


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