NX Open C++ Reference Guide
Public Types | Public Member Functions
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

List of all members.

Public Types

enum  DrwDestination { DrwDestinationDrawingSheet, DrwDestinationModel }
 Enum which defines where the geometry is to be placed. More...
enum  Types { TypesComponentAttribute, TypesCgmFileSelection, TypesPatternFileSelection }
 Enum which defines the type to import CGM/Pattern file. More...

Public Member Functions

NXString CgmflBrsr ()
 Returns the browser which enables selection of CGM file when Formboard::FaceAnnotationBuilder::Types is Formboard::FaceAnnotationBuilder::TypesCgmFileSelection .
NXOpen::SelectNXObjectCompSel ()
 Returns the user selected component which has a CGM_FILE or PATTERN_FILE attribute defined.
NXOpen::Formboard::FaceAnnotationBuilder::DrwDestination DestEnum ()
 Returns the Formboard::FaceAnnotationBuilder::DrwDestination selected by user to place the geometry
Created in NX7.5.0.
NXOpen::PointPntOrigin ()
 Returns the user selected point where geometry will be placed
Created in NX7.5.0.
void SetCgmflBrsr (const NXString &filename)
 Sets the browser which enables selection of CGM file when Formboard::FaceAnnotationBuilder::Types is Formboard::FaceAnnotationBuilder::TypesCgmFileSelection .
void SetDestEnum (NXOpen::Formboard::FaceAnnotationBuilder::DrwDestination destEnum)
 Sets the Formboard::FaceAnnotationBuilder::DrwDestination selected by user to place the geometry
Created in NX7.5.0.
void SetPntOrigin (NXOpen::Point *pntOrigin)
 Sets the user selected point where geometry will be placed
Created in NX7.5.0.
void SetStrAnnot (const NXString &strAnnot)
 Sets the string to display the name of Pattern file name selected by user.
void SetStrAnnotFileName (const NXString &strAnnot)
 Sets the string to display the name of CGM name selected by user.
void SetTogBlank (bool togBlank)
 Sets the toggle which defines whether the selected component is to be blanked or not
Created in NX7.5.0.
void SetType (NXOpen::Formboard::FaceAnnotationBuilder::Types type)
 Sets the Formboard::FaceAnnotationBuilder::Types selected by user
Created in NX7.5.0.
NXString StrAnnot ()
 Returns the string to display the name of Pattern file name selected by user.
NXString StrAnnotFileName ()
 Returns the string to display the name of CGM name selected by user.
bool TogBlank ()
 Returns the toggle which defines whether the selected component is to be blanked or not
Created in NX7.5.0.
NXOpen::Formboard::FaceAnnotationBuilder::Types Type ()
 Returns the Formboard::FaceAnnotationBuilder::Types selected by user
Created in NX7.5.0.

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 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:
DrwDestinationDrawingSheet 

Place geometry in drawing sheet.

DrwDestinationModel 

Place geometry in model.

Enum which defines the type to import CGM/Pattern file.

Enumerator:
TypesComponentAttribute 

Import CGM file by selecting a component.

TypesCgmFileSelection 

Import CGM file by browsing a CGM file.

TypesPatternFileSelection 

Import a pattern file.


Member Function Documentation

Returns the browser which enables selection of CGM file when Formboard::FaceAnnotationBuilder::Types is Formboard::FaceAnnotationBuilder::TypesCgmFileSelection .


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

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


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Returns the Formboard::FaceAnnotationBuilder::DrwDestination selected by user to place the geometry
Created in NX7.5.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Returns the user selected point where geometry will be placed
Created in NX7.5.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Sets the browser which enables selection of CGM file when Formboard::FaceAnnotationBuilder::Types is Formboard::FaceAnnotationBuilder::TypesCgmFileSelection .


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
filenamefilename

Sets the Formboard::FaceAnnotationBuilder::DrwDestination selected by user to place the geometry
Created in NX7.5.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
destEnumdestenum

Sets the user selected point where geometry will be placed
Created in NX7.5.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
pntOriginpntorigin

Sets the string to display the name of Pattern file name selected by user.


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
strAnnotstrannot

Sets the string to display the name of CGM name selected by user.


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
strAnnotstrannot

Sets the toggle which defines whether the selected component is to be blanked or not
Created in NX7.5.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
togBlanktogblank

Sets the Formboard::FaceAnnotationBuilder::Types selected by user
Created in NX7.5.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
typetype

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


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

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


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Returns the toggle which defines whether the selected component is to be blanked or not
Created in NX7.5.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Returns the Formboard::FaceAnnotationBuilder::Types selected by user
Created in NX7.5.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")


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