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

Represents a NXOpen::Annotations::DrawingFormatTitleBuilder
Created in NX9.0.0. More...

Inheritance diagram for NXOpen::Annotations::DrawingFormatTitleBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  TitleBlockPositionType { TitleBlockPositionTypeTopLeft, TitleBlockPositionTypeTopRight, TitleBlockPositionTypeBottomLeft, TitleBlockPositionTypeBottomRight }
 Represent the option of TitleBlockPosition that specifies Type display. More...
 

Public Member Functions

bool Automatic ()
 Returns the flag that determines whether or not the title block updates automatically whenever a change occurs to a referenced object in the model
Created in NX9.0.0. More...
 
void SetAutomatic (bool automatic)
 Sets the flag that determines whether or not the title block updates automatically whenever a change occurs to a referenced object in the model
Created in NX9.0.0. More...
 
void SetTitleBlockAlignmentPosition (NXOpen::Annotations::DrawingFormatTitleBuilder::TitleBlockPositionType titleBlockAlignmentPosition)
 Sets the option that specifies how the title block aligns relative to the cursor during placement
Created in NX9.0.0. More...
 
NXOpen::Annotations::DrawingFormatTitleBuilder::TitleBlockPositionType TitleBlockAlignmentPosition ()
 Returns the option that specifies how the title block aligns relative to the cursor during placement
Created in NX9.0.0. 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

Represents a NXOpen::Annotations::DrawingFormatTitleBuilder
Created in NX9.0.0.


Member Enumeration Documentation

Represent the option of TitleBlockPosition that specifies Type display.

Enumerator
TitleBlockPositionTypeTopLeft 

top left

TitleBlockPositionTypeTopRight 

top right

TitleBlockPositionTypeBottomLeft 

bottom left

TitleBlockPositionTypeBottomRight 

bottom right

Member Function Documentation

bool NXOpen::Annotations::DrawingFormatTitleBuilder::Automatic ( )

Returns the flag that determines whether or not the title block updates automatically whenever a change occurs to a referenced object in the model
Created in NX9.0.0.



License requirements : None

void NXOpen::Annotations::DrawingFormatTitleBuilder::SetAutomatic ( bool  automatic)

Sets the flag that determines whether or not the title block updates automatically whenever a change occurs to a referenced object in the model
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
automaticautomatic
void NXOpen::Annotations::DrawingFormatTitleBuilder::SetTitleBlockAlignmentPosition ( NXOpen::Annotations::DrawingFormatTitleBuilder::TitleBlockPositionType  titleBlockAlignmentPosition)

Sets the option that specifies how the title block aligns relative to the cursor during placement
Created in NX9.0.0.



License requirements : drafting ("DRAFTING")

Parameters
titleBlockAlignmentPositiontitleblockalignmentposition
NXOpen::Annotations::DrawingFormatTitleBuilder::TitleBlockPositionType NXOpen::Annotations::DrawingFormatTitleBuilder::TitleBlockAlignmentPosition ( )

Returns the option that specifies how the title block aligns relative to the cursor during placement
Created in NX9.0.0.



License requirements : None

virtual bool NXOpen::Annotations::DrawingFormatTitleBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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