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

Represents custom symbol data
More...

Inheritance diagram for NXOpen::Annotations::CustomSymbolData:
NXOpen::TransientObject

Public Member Functions

double Angle ()
 Frees the object from memory. More...
 
std::vector
< NXOpen::Annotations::CustomSymbolTextData * > 
GetTextData ()
 Return the text data. More...
 
double Scale ()
 Returns the scale
More...
 
NXOpen::ExpressionScaleExpression ()
 Returns the scale expression
More...
 
void SetAngle (double angle)
 Sets the angle
More...
 
void SetScale (double scale)
 Sets the scale
More...
 
void SetScaleExpression (NXOpen::Expression *scaleExpression)
 Sets the scale expression
More...
 
void SetSymbolPreferencesOption (NXOpen::Annotations::SymbolPreferencesOption option)
 Sets the symbol preferences option. More...
 
void SetTextData (const std::vector< NXOpen::Annotations::CustomSymbolTextData * > &data)
 Sets the text data
More...
 
void SetTextPreferencesOption (NXOpen::Annotations::TextPreferencesOption option)
 Sets the text preferences option. More...
 
NXOpen::Annotations::SymbolPreferencesOption SymbolPreferencesOption ()
 Returns the symbol preferences option. More...
 
NXOpen::Annotations::TextPreferencesOption TextPreferencesOption ()
 Returns the text preferences option. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents custom symbol data

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.


Created in NX4.0.0.

Member Function Documentation

double NXOpen::Annotations::CustomSymbolData::Angle ( )

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Deprecated:
Deprecated in NX9.0.0. Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.


Created in NX4.0.0.

License requirements : None Returns the angle

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.


Created in NX4.0.0.

License requirements : None

std::vector<NXOpen::Annotations::CustomSymbolTextData *> NXOpen::Annotations::CustomSymbolData::GetTextData ( )

Return the text data.

Returns
List of text data objects
Deprecated:
Deprecated in NX9.0.0. Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.


Created in NX4.0.0.

License requirements : None

double NXOpen::Annotations::CustomSymbolData::Scale ( )

Returns the scale

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.


Created in NX4.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Annotations::CustomSymbolData::ScaleExpression ( )

Returns the scale expression

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.


Created in NX4.0.0.

License requirements : None

void NXOpen::Annotations::CustomSymbolData::SetAngle ( double  angle)

Sets the angle

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.


Created in NX4.0.0.

License requirements : None

Parameters
angleNew angle at which custom symbol will be oriented
void NXOpen::Annotations::CustomSymbolData::SetScale ( double  scale)

Sets the scale

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.


Created in NX4.0.0.

License requirements : None

Parameters
scaleNew scale
void NXOpen::Annotations::CustomSymbolData::SetScaleExpression ( NXOpen::Expression scaleExpression)

Sets the scale expression

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.


Created in NX4.0.0.

License requirements : None

Parameters
scaleExpressionNew scale expression
void NXOpen::Annotations::CustomSymbolData::SetSymbolPreferencesOption ( NXOpen::Annotations::SymbolPreferencesOption  option)

Sets the symbol preferences option.

This option is only available when creating.

Deprecated:
Deprecated in NX9.0.0. Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.


Created in NX4.0.0.

License requirements : None

Parameters
optionNew symbol preferences option
void NXOpen::Annotations::CustomSymbolData::SetTextData ( const std::vector< NXOpen::Annotations::CustomSymbolTextData * > &  data)

Sets the text data

Deprecated:
Deprecated in NX9.0.0.

Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.


Created in NX4.0.0.

License requirements : None

Parameters
dataList of text data objects
void NXOpen::Annotations::CustomSymbolData::SetTextPreferencesOption ( NXOpen::Annotations::TextPreferencesOption  option)

Sets the text preferences option.

This option is only available when creating.

Deprecated:
Deprecated in NX9.0.0. Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.


Created in NX4.0.0.

License requirements : None

Parameters
optionNew text preferences option
NXOpen::Annotations::SymbolPreferencesOption NXOpen::Annotations::CustomSymbolData::SymbolPreferencesOption ( )

Returns the symbol preferences option.

This option is only available when creating.

Deprecated:
Deprecated in NX9.0.0. Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.


Created in NX4.0.0.

License requirements : None

NXOpen::Annotations::TextPreferencesOption NXOpen::Annotations::CustomSymbolData::TextPreferencesOption ( )

Returns the text preferences option.

This option is only available when creating.

Deprecated:
Deprecated in NX9.0.0. Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.


Created in NX4.0.0.

License requirements : None


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