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

Represents a NXOpen.Annotations.Note builder More...

Inheritance diagram for NXOpen.Annotations.DraftingNoteBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink NXOpen.Annotations.PmiNoteBuilder NXOpen.CAE.CaeNoteBuilder NXOpen.TDP.TemplateNoteBuilder NXOpen.CAE.AeroStructures.MarginAnnotBuilder

Public Types

enum  TextAlign {
  Top, Middle, Bottom, BelowbottomExtToMax,
  BelowbottomExtToMaxUnderline, Belowbottom, BelowbottomUnderline, BelowTopExtToMax,
  BelowTopExtToMaxUnderline, BelowTop, BelowTopUnderline
}
 text over leader types for text More...
 
enum  ThicknessTypes { Medium, Thick }
 thickness types for text More...
 

Public Member Functions

unsafe void InheritProperties (NXOpen.Annotations.SimpleDraftingAid annotation, int recordNumber)
 Inheriting properties from the note 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...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. 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...
 

Properties

unsafe
NXOpen.Annotations.ForeshorteningSymbolBuilder 
ForeshorteningSymbol [get]
 Returns the foreshortening symbol builder More...
 
unsafe
NXOpen.SelectDisplayableObject 
Inherit [get]
 Returns the note from which the properties are inherited More...
 
unsafe
NXOpen.Annotations.LeaderBuilder 
Leader [get]
 Returns the NXOpen.Annotations.LeaderBuilder for the annotation More...
 
unsafe
NXOpen.Annotations.OriginBuilder 
Origin [get]
 Returns the origin More...
 
unsafe
NXOpen.Annotations.StyleBuilder 
Style [get]
 Returns the style builder More...
 
unsafe
NXOpen.Annotations.TextWithEditControlsBuilder 
Text [get]
 Returns the text More...
 
unsafe
NXOpen.Annotations.DraftingNoteBuilder.TextAlign 
TextAlignment [get, set]
 Returns or sets the text alignment More...
 
unsafe bool VerticalText [get, set]
 Returns or sets the vertical text for text More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.Annotations.Note builder

To create a new instance of this class, use NXOpen.Annotations.AnnotationManager.CreateDraftingNoteBuilder

Default values.

Property Value

Text.TextBlock.CustomSymbolScale

1.0

Text.TextBlock.SymbolAspectRatio

1.0

Text.TextBlock.SymbolHeight

25.4 (millimeters part), 1.0 (inches part)

Text.TextBlock.SymbolLength

25.4 (millimeters part), 1.0 (inches part)

Text.TextBlock.SymbolPreferences

UseCurrent

Text.TextBlock.SymbolScale

1.0

Text.TextBlock.SymbolSizeMethod

ScaleAndAspectRatio

Created in NX6.0.0

Member Enumeration Documentation

text over leader types for text

Enumerator
Top 

Align top

Middle 

Align middle

Bottom 

Align bottom

BelowbottomExtToMax 

Align below bottom extension to maximum

BelowbottomExtToMaxUnderline 

Align below bottom extension to maximum and underline

Belowbottom 

Align below bottom

BelowbottomUnderline 

Align below bottom and underline

BelowTopExtToMax 

Align below top extension to maximum

BelowTopExtToMaxUnderline 

Align below top extension to maximum and underline

BelowTop 

Align below top

BelowTopUnderline 

Align below top and underline

thickness types for text

Enumerator
Medium 

Medium thickness type

Thick 

Thick thickness type

Member Function Documentation

unsafe void NXOpen.Annotations.DraftingNoteBuilder.InheritProperties ( NXOpen.Annotations.SimpleDraftingAid  annotation,
int  recordNumber 
)
inline

Inheriting properties from the note

Created in NX7.5.2

License requirements: None.

Parameters
annotation
recordNumber

Property Documentation

unsafe NXOpen.Annotations.ForeshorteningSymbolBuilder NXOpen.Annotations.DraftingNoteBuilder.ForeshorteningSymbol
get

Returns the foreshortening symbol builder

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.SelectDisplayableObject NXOpen.Annotations.DraftingNoteBuilder.Inherit
get

Returns the note from which the properties are inherited

Created in NX7.5.2

License requirements: None.

unsafe NXOpen.Annotations.LeaderBuilder NXOpen.Annotations.DraftingNoteBuilder.Leader
get

Returns the NXOpen.Annotations.LeaderBuilder for the annotation

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Annotations.OriginBuilder NXOpen.Annotations.DraftingNoteBuilder.Origin
get

Returns the origin

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Annotations.StyleBuilder NXOpen.Annotations.DraftingNoteBuilder.Style
get

Returns the style builder

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Annotations.TextWithEditControlsBuilder NXOpen.Annotations.DraftingNoteBuilder.Text
get

Returns the text

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Annotations.DraftingNoteBuilder.TextAlign NXOpen.Annotations.DraftingNoteBuilder.TextAlignment
getset

Returns or sets the text alignment

Created in NX6.0.0

License requirements to get this property: drafting ("DRAFTING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

License requirements to set this property: drafting ("DRAFTING") OR geometric_tol ("GDT") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

unsafe bool NXOpen.Annotations.DraftingNoteBuilder.VerticalText
getset

Returns or sets the vertical text for text

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: drafting ("DRAFTING") OR geometric_tol ("GDT") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")


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