NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Formboard::ObjectAttributeReferenceBuilder Class Reference

Builder for "object attribute" used in formboard which enbles user to create annotation in drafting functionality. More...

Inheritance diagram for NXOpen::Formboard::ObjectAttributeReferenceBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  LeaderType { LeaderTypeNone, LeaderTypeSingleLocation, LeaderTypeStartandEndLocations }
 Enum which defines types of leader user wants to associate with the annotation. More...
 

Public Member Functions

NXOpen::Annotations::LeaderBuilderAnnotLeader ()
 Returns the Annotations::LeaderBuilder for the annotation
Created in NX7.5.0. More...
 
NXOpen::Annotations::OriginBuilderCompOrigin ()
 Returns the comp origin
Created in NX7.5.0. More...
 
NXOpen::Formboard::ObjectAttributeReferenceBuilder::LeaderType EnumType ()
 Returns the enum type
Created in NX7.5.0. More...
 
NXOpen::SelectNXObjectObjectSelection ()
 Returns the object selected by user to associated annotation
Created in NX7.5.0. More...
 
void SetEnumType (NXOpen::Formboard::ObjectAttributeReferenceBuilder::LeaderType enumType)
 Sets the enum type
Created in NX7.5.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Builder for "object attribute" used in formboard which enbles user to create annotation in drafting functionality.

It creates a tabular note and displays object attributes of a single object selected by user.
To create a new instance of this class, use NXOpen::Formboard::FormboardManager::CreateObjectAttributeReferenceBuilder
Default values.

Property Value

EnumType

None


Created in NX7.5.0.

Member Enumeration Documentation

Enum which defines types of leader user wants to associate with the annotation.

User can either create no leader or one or two leader for the annotation when picking the associated object.

Enumerator
LeaderTypeNone 

No leader for annotation of selected object.

LeaderTypeSingleLocation 

Single leader for the annotation of selected object.

LeaderTypeStartandEndLocations 

Two leaders for annotation with start and end location.

Member Function Documentation

NXOpen::Annotations::LeaderBuilder* NXOpen::Formboard::ObjectAttributeReferenceBuilder::AnnotLeader ( )

Returns the Annotations::LeaderBuilder for the annotation
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

NXOpen::Annotations::OriginBuilder* NXOpen::Formboard::ObjectAttributeReferenceBuilder::CompOrigin ( )

Returns the comp origin
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

NXOpen::Formboard::ObjectAttributeReferenceBuilder::LeaderType NXOpen::Formboard::ObjectAttributeReferenceBuilder::EnumType ( )

Returns the enum type
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

NXOpen::SelectNXObject* NXOpen::Formboard::ObjectAttributeReferenceBuilder::ObjectSelection ( )

Returns the object selected by user to associated annotation
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

void NXOpen::Formboard::ObjectAttributeReferenceBuilder::SetEnumType ( NXOpen::Formboard::ObjectAttributeReferenceBuilder::LeaderType  enumType)

Sets the enum type
Created in NX7.5.0.



License requirements : routing_harness ("Routing Harness")

Parameters
enumTypeenumtype

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