NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::PID::PreferencesAnnotationBuilder Class Reference

Represents a PreferencesAnnotationBuilder. More...

Inheritance diagram for NXOpen::PID::PreferencesAnnotationBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::Diagramming::DiagrammingConnectionlabelhorizontaloffsetposition ConnectionLabelHorizontalOffsetPosition ()
 Returns the horizontal position of the connection tag. More...
 
double ConnectionLabelOffset ()
 Returns the gap between the connection and the tag. More...
 
bool ConnectionLabelPositionCenter ()
 Returns the tag is displayed at the center of the connection. More...
 
NXOpen::Diagramming::DiagrammingConnectionlabelverticaloffsetposition ConnectionLabelVerticalOffsetPosition ()
 Returns the vertical position of the connection tag. More...
 
void SetConnectionLabelHorizontalOffsetPosition (NXOpen::Diagramming::DiagrammingConnectionlabelhorizontaloffsetposition position)
 Sets the horizontal position of the connection tag. More...
 
void SetConnectionLabelOffset (double offset)
 Sets the gap between the connection and the tag. More...
 
void SetConnectionLabelPositionCenter (bool center)
 Sets the tag is displayed at the center of the connection. More...
 
void SetConnectionLabelVerticalOffsetPosition (NXOpen::Diagramming::DiagrammingConnectionlabelverticaloffsetposition position)
 Sets the vertical position of the connection tag. More...
 
NXOpen::Diagramming::Tables::CellSettingsBuilderTablesCellSettings ()
 Returns the preferences tabular note settings builder
Created in NX12.0.0. More...
 
NXOpen::Diagramming::TextStyleBuilderTextStyleConnectionBuilder ()
 Returns the connection text style of the Annotation. More...
 
NXOpen::Diagramming::TextStyleBuilderTextStyleNoteBuilder ()
 Returns the note text style of the Annotation. 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 PreferencesAnnotationBuilder.


Created in NX11.0.1.

Member Function Documentation

NXOpen::Diagramming::DiagrammingConnectionlabelhorizontaloffsetposition NXOpen::PID::PreferencesAnnotationBuilder::ConnectionLabelHorizontalOffsetPosition ( )

Returns the horizontal position of the connection tag.


Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

double NXOpen::PID::PreferencesAnnotationBuilder::ConnectionLabelOffset ( )

Returns the gap between the connection and the tag.


Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

bool NXOpen::PID::PreferencesAnnotationBuilder::ConnectionLabelPositionCenter ( )

Returns the tag is displayed at the center of the connection.


Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

NXOpen::Diagramming::DiagrammingConnectionlabelverticaloffsetposition NXOpen::PID::PreferencesAnnotationBuilder::ConnectionLabelVerticalOffsetPosition ( )

Returns the vertical position of the connection tag.


Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

void NXOpen::PID::PreferencesAnnotationBuilder::SetConnectionLabelHorizontalOffsetPosition ( NXOpen::Diagramming::DiagrammingConnectionlabelhorizontaloffsetposition  position)

Sets the horizontal position of the connection tag.


Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
positionposition
void NXOpen::PID::PreferencesAnnotationBuilder::SetConnectionLabelOffset ( double  offset)

Sets the gap between the connection and the tag.


Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
offsetoffset
void NXOpen::PID::PreferencesAnnotationBuilder::SetConnectionLabelPositionCenter ( bool  center)

Sets the tag is displayed at the center of the connection.


Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
centercenter
void NXOpen::PID::PreferencesAnnotationBuilder::SetConnectionLabelVerticalOffsetPosition ( NXOpen::Diagramming::DiagrammingConnectionlabelverticaloffsetposition  position)

Sets the vertical position of the connection tag.


Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters
positionposition
NXOpen::Diagramming::Tables::CellSettingsBuilder* NXOpen::PID::PreferencesAnnotationBuilder::TablesCellSettings ( )

Returns the preferences tabular note settings builder
Created in NX12.0.0.



License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

NXOpen::Diagramming::TextStyleBuilder* NXOpen::PID::PreferencesAnnotationBuilder::TextStyleConnectionBuilder ( )

Returns the connection text style of the Annotation.


Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

NXOpen::Diagramming::TextStyleBuilder* NXOpen::PID::PreferencesAnnotationBuilder::TextStyleNoteBuilder ( )

Returns the note text style of the Annotation.


Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

virtual bool NXOpen::PID::PreferencesAnnotationBuilder::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.