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

Builder for Face Annotation functionality used in formboard. More...

Inheritance diagram for NXOpen.Formboard.FaceAnnotationBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  DrwDestination { DrawingSheet, Model }
 Enum which defines where the geometry is to be placed. More...
 
enum  Types { ComponentAttribute, CgmFileSelection, PatternFileSelection }
 Enum which defines the type to import CGM/Pattern file More...
 

Properties

unsafe string CgmflBrsr [get, set]
 Returns or sets the browser which enables selection of CGM file when Formboard.FaceAnnotationBuilder.Types is Formboard.FaceAnnotationBuilder.Types.CgmFileSelection . More...
 
unsafe NXOpen.SelectNXObject CompSel [get]
 Returns the user selected component which has a CGM_FILE or PATTERN_FILE attribute defined. More...
 
unsafe
NXOpen.Formboard.FaceAnnotationBuilder.DrwDestination 
DestEnum [get, set]
 Returns or sets the NXOpen.Formboard.FaceAnnotationBuilder.DrwDestination selected by user to place the geometry More...
 
unsafe NXOpen.Point PntOrigin [get, set]
 Returns or sets the user selected point where geometry will be placed More...
 
unsafe string StrAnnot [get, set]
 Returns or sets the string to display the name of Pattern file name selected by user. More...
 
unsafe string StrAnnotFileName [get, set]
 Returns or sets the string to display the name of CGM name selected by user. More...
 
unsafe bool TogBlank [get, set]
 Returns or sets the toggle which defines whether the selected component is to be blanked or not More...
 
unsafe
NXOpen.Formboard.FaceAnnotationBuilder.Types 
Type [get, set]
 Returns or sets the NXOpen.Formboard.FaceAnnotationBuilder.Types selected by user 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

- 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...
 
- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Builder for Face Annotation functionality used in formboard.

It allows importing CGM or Pattern file geometry and placing it on a drawing sheet or model view. As a result of this a group of dumb geometry is placed such that defined origin is located at the lower left hand of the bounding box containing the group of geometry.

To create a new instance of this class, use NXOpen.Formboard.FormboardManager.CreateFaceAnnotationBuilder

Default values.

Property Value

DestEnum

DrawingSheet

TogBlank

0

Created in NX7.5.0

Member Enumeration Documentation

Enum which defines where the geometry is to be placed.

The geometry can be placed either in model or drawing sheet.

Enumerator
DrawingSheet 

Place geometry in drawing sheet

Model 

Place geometry in model

Enum which defines the type to import CGM/Pattern file

Enumerator
ComponentAttribute 

Import CGM file by selecting a component

CgmFileSelection 

Import CGM file by browsing a CGM file

PatternFileSelection 

Import a pattern file

Property Documentation

unsafe string NXOpen.Formboard.FaceAnnotationBuilder.CgmflBrsr
getset

Returns or sets the browser which enables selection of CGM file when Formboard.FaceAnnotationBuilder.Types is Formboard.FaceAnnotationBuilder.Types.CgmFileSelection .

Created in NX7.5.0

License requirements to get this property: routing_harness ("Routing Harness")

License requirements to set this property: routing_harness ("Routing Harness")

unsafe NXOpen.SelectNXObject NXOpen.Formboard.FaceAnnotationBuilder.CompSel
get

Returns the user selected component which has a CGM_FILE or PATTERN_FILE attribute defined.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

unsafe NXOpen.Formboard.FaceAnnotationBuilder.DrwDestination NXOpen.Formboard.FaceAnnotationBuilder.DestEnum
getset

Returns or sets the NXOpen.Formboard.FaceAnnotationBuilder.DrwDestination selected by user to place the geometry

Created in NX7.5.0

License requirements to get this property: routing_harness ("Routing Harness")

License requirements to set this property: routing_harness ("Routing Harness")

unsafe NXOpen.Point NXOpen.Formboard.FaceAnnotationBuilder.PntOrigin
getset

Returns or sets the user selected point where geometry will be placed

Created in NX7.5.0

License requirements to get this property: routing_harness ("Routing Harness")

License requirements to set this property: routing_harness ("Routing Harness")

unsafe string NXOpen.Formboard.FaceAnnotationBuilder.StrAnnot
getset

Returns or sets the string to display the name of Pattern file name selected by user.

Created in NX7.5.0

License requirements to get this property: routing_harness ("Routing Harness")

License requirements to set this property: routing_harness ("Routing Harness")

unsafe string NXOpen.Formboard.FaceAnnotationBuilder.StrAnnotFileName
getset

Returns or sets the string to display the name of CGM name selected by user.

Created in NX7.5.0

License requirements to get this property: routing_harness ("Routing Harness")

License requirements to set this property: routing_harness ("Routing Harness")

unsafe bool NXOpen.Formboard.FaceAnnotationBuilder.TogBlank
getset

Returns or sets the toggle which defines whether the selected component is to be blanked or not

Created in NX7.5.0

License requirements to get this property: routing_harness ("Routing Harness")

License requirements to set this property: routing_harness ("Routing Harness")

unsafe NXOpen.Formboard.FaceAnnotationBuilder.Types NXOpen.Formboard.FaceAnnotationBuilder.Type
getset

Returns or sets the NXOpen.Formboard.FaceAnnotationBuilder.Types selected by user

Created in NX7.5.0

License requirements to get this property: routing_harness ("Routing Harness")

License requirements to set this property: routing_harness ("Routing Harness")


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