NX Open C++ 参考指南 2406 v1.1
载入中...
搜索中...
未找到
Public 类型 | Public 成员函数 | 所有成员列表
NXOpen::Annotations::AssociativeText类 参考

关联文本 更多...

#include <Annotations_AssociativeText.hxx>

类 NXOpen::Annotations::AssociativeText 继承关系图:
NXOpen::TransientObject

Public 类型

enum  PropertyType {
  PropertyTypeDrawingNumberOfSheets , PropertyTypeDrawingNumberOfPrimarySheets , PropertyTypeDrawingSheetName , PropertyTypeDrawingSheetNumber ,
  PropertyTypeDrawingSheetRevision , PropertyTypeDrawingSheetScaleNumerator , PropertyTypeDrawingSheetScaleDenominator , PropertyTypeDrawingSheetSize ,
  PropertyTypeDrawingSheetUnits , PropertyTypeDrawingSheetZone , PropertyTypeDrawingSheetProjectionAngle , PropertyTypeDrawingMasterPartName ,
  PropertyTypeDrawingPartName , PropertyTypeDrawingViewPrefix , PropertyTypeDrawingViewRotationAngle
}

Public 成员函数

NXString GetEvaluatedText (NXOpen::Annotations::Annotation *ann, const char *text)
NXString GetEvaluatedText (NXOpen::Annotations::Annotation *ann, const NXString &text)
bool GetObjectAttribute (const char *text, NXOpen::NXObject **object, NXString *attributeTitle)
bool GetObjectAttribute (const NXString &text, NXOpen::NXObject **object, NXString *attributeTitle)
NXString GetObjectAttributeText (NXOpen::NXObject *object, const char *attributeTitle)
NXString GetObjectAttributeText (NXOpen::NXObject *object, const NXString &attributeTitle)
NXString GetObjectAttributeTextFormatted (NXOpen::NXObject *object, const char *attributeTitle, int decimalPlaces)
NXString GetObjectAttributeTextFormatted (NXOpen::NXObject *object, const NXString &attributeTitle, int decimalPlaces)
NXString GetObjectPropertyText (NXOpen::NXObject *object, NXOpen::Annotations::AssociativeText::PropertyType type)
bool GetPartAttribute (const char *text, NXString *attributeTitle)
bool GetPartAttribute (const NXString &text, NXString *attributeTitle)
NXString GetPartAttributeText (const char *attributeTitle)
NXString GetPartAttributeText (const NXString &attributeTitle)
NXString GetPartAttributeTextFormatted (const char *attributeTitle, int decimalPlaces)
NXString GetPartAttributeTextFormatted (const NXString &attributeTitle, int decimalPlaces)
virtual ~AssociativeText ()
Public 成员函数 继承自 NXOpen::TransientObject
void * GetHandle ()

详细描述

关联文本

关联文本类用于创建与对象和部件属性以及对象属性（如工程图纸名称）关联的文本。 关联文本使用特殊的 NX 文本控制序列构建。
使用此类创建的文本可以添加到表格单元格、注释文本、尺寸附加文本等中。

使用此类中的函数从文本中查询/提取信息并创建关联文本。

客户端不应解析 NX 文本控制序列来提取信息。 文本控制序列可能随版本更新而变化。

在 NX8.0.0 中创建。

成员枚举类型说明

◆ PropertyType

enum NXOpen::Annotations::AssociativeText::PropertyType

用于对象的关联文本属性类型

枚举值
PropertyTypeDrawingNumberOfSheets 

工程图图纸总数

PropertyTypeDrawingNumberOfPrimarySheets 

工程图主图纸数量

PropertyTypeDrawingSheetName 

工程图图纸名称

PropertyTypeDrawingSheetNumber 

工程图图纸编号

PropertyTypeDrawingSheetRevision 

工程图图纸版本

PropertyTypeDrawingSheetScaleNumerator 

工程图图纸比例分子

PropertyTypeDrawingSheetScaleDenominator 

工程图图纸比例分母

PropertyTypeDrawingSheetSize 

工程图图纸大小

PropertyTypeDrawingSheetUnits 

工程图图纸单位

PropertyTypeDrawingSheetZone 

工程图图纸区域

PropertyTypeDrawingSheetProjectionAngle 

工程图图纸投影角

PropertyTypeDrawingMasterPartName 

工程图主部件名称

PropertyTypeDrawingPartName 

工程图部件名称

PropertyTypeDrawingViewPrefix 

工程图视图前缀

PropertyTypeDrawingViewRotationAngle 

视图旋转角度

构造及析构函数说明

◆ ~AssociativeText()

virtual NXOpen::Annotations::AssociativeText::~AssociativeText ( )
virtual

从内存中释放对象。调用此方法后， 再使用该对象将是非法的。在 .NET 中，当垃圾回收器删除对象时， 此方法会自动调用。
在 NX8.0.0 中创建。

许可要求：无

成员函数说明

◆ GetEvaluatedText() [1/2]

NXString NXOpen::Annotations::AssociativeText::GetEvaluatedText ( NXOpen::Annotations::Annotation * ann,
const char * text )

计算指定的关联文本。将关联文本转换为其表示的字符串。 将计算以下关联文本控制序列：零件属性引用、对象属性引用、表达式引用和对象属性引用。 示例： 零件属性 "ATT1" 的值为 "Value1"。表示对零件属性 "ATT1" 引用的文本是 "\<W\@ATT1\>"。 表达式 "p1" 的值为 "3.00"。表示对表达式 "p1" 引用的文本是 "\<X0.2\@p1\>"。 对象属性 "\<WRef1*0\@$SH_SHEET_NAME\>" 的值为 "Sheet 1"。 给定输入文本 "\<WRef1*0\@$SH_SHEET_NAME\> \<X0.2\@p1\> \<W\@ATT1\>"， 返回的计算后文本将是 "Sheet 1 3.00 Value1"。

返回
包含计算后关联文本的文本
创建于NX8.0.0。

许可要求：无
参数
ann用于在未指定对象时确定对象属性值的注释。 例如，给定注释 123 和 456，其中 123 位于 "Sheet 1"，456 位于 "Sheet 2"， 则对于输入文本 "\<W\@$SH_SHEET_NAME\>"，注释 123 返回的计算文本是 "Sheet 1"，注释 456 返回的是 "Sheet 2"
text包含要计算的关联文本的文本

◆ GetEvaluatedText() [2/2]

NXString NXOpen::Annotations::AssociativeText::GetEvaluatedText ( NXOpen::Annotations::Annotation * ann,
const NXString & text )

计算指定的关联文本。将关联文本转换为其表示的字符串。 将计算以下关联文本控制序列：零件属性引用、对象属性引用、表达式引用和对象属性引用。 示例： 零件属性 "ATT1" 的值为 "Value1"。表示对零件属性 "ATT1" 引用的文本是 "\<W\@ATT1\>"。 表达式 "p1" 的值为 "3.00"。表示对表达式 "p1" 引用的文本是 "\<X0.2\@p1\>"。 对象属性 "\<WRef1*0\@$SH_SHEET_NAME\>" 的值为 "Sheet 1"。 给定输入文本 "\<WRef1*0\@$SH_SHEET_NAME\> \<X0.2\@p1\> \<W\@ATT1\>"， 返回的计算后文本将是 "Sheet 1 3.00 Value1"。

返回
包含计算后关联文本的文本
创建于NX8.0.0。

许可要求：无
参数
ann用于在未指定对象时确定对象属性值的注释。 例如，给定注释 123 和 456，其中 123 位于 "Sheet 1"，456 位于 "Sheet 2"， 则对于输入文本 "\<W\@$SH_SHEET_NAME\>"，注释 123 返回的计算文本是 "Sheet 1"，注释 456 返回的是 "Sheet 2"
text包含要计算的关联文本的文本

◆ GetObjectAttribute() [1/2]

bool NXOpen::Annotations::AssociativeText::GetObjectAttribute ( const char * text,
NXOpen::NXObject ** object,
NXString * attributeTitle )

返回关联文本中引用的对象属性的标题和所属对象。 如果文本控制序列的语法反映了对象属性引用，则认为找到了该引用。 对于不存在的属性引用将返回错误。
示例 1: "\<WRef2*0@PartAttTitle\>" 是对部件属性 "PartAttTitle" 的现有引用，因此该引用 将被视为部件属性引用。不会返回任何对象或标题。

示例 2: "\<W@AttTitle\>" 使用了部件属性语法，因此该引用将被视为 部件属性引用。不会返回任何对象或标题。

示例 3: "\<WRef1*0@ObjAttTitle\>" 是对对象属性 "ObjAttTitle" 的现有引用，因此该引用 将被视为对象属性引用。包含该属性的对象和 "ObjAttTitle" 将作为属性标题返回。请注意，包含该属性的对象将位于 拥有此关联文本对象的部件中。

示例 4: "\<WRef10*0@AttTitle\>" 其中 "Ref10*0" 引用不存在，将被视为无效的属性引用。 将返回错误。请注意，仅在拥有此关联文本对象的部件中 检查 "Ref10*0" 是否存在。

返回
对象属性引用是否被找到。
在 NX8.5.3 中创建。

许可要求：无
参数
text要查询的关联文本
object对象
attributeTitle对象属性标题

◆ GetObjectAttribute() [2/2]

bool NXOpen::Annotations::AssociativeText::GetObjectAttribute ( const NXString & text,
NXOpen::NXObject ** object,
NXString * attributeTitle )

返回关联文本中引用的对象属性的标题和所属对象。 如果文本控制序列的语法反映了对象属性引用，则认为找到了该引用。 对于不存在的属性引用将返回错误。
示例 1: "\<WRef2*0@PartAttTitle\>" 是对部件属性 "PartAttTitle" 的现有引用，因此该引用 将被视为部件属性引用。不会返回任何对象或标题。

示例 2: "\<W@AttTitle\>" 使用了部件属性语法，因此该引用将被视为 部件属性引用。不会返回任何对象或标题。

示例 3: "\<WRef1*0@ObjAttTitle\>" 是对对象属性 "ObjAttTitle" 的现有引用，因此该引用 将被视为对象属性引用。包含该属性的对象和 "ObjAttTitle" 将作为属性标题返回。请注意，包含该属性的对象将位于 拥有此关联文本对象的部件中。

示例 4: "\<WRef10*0@AttTitle\>" 其中 "Ref10*0" 引用不存在，将被视为无效的属性引用。 将返回错误。请注意，仅在拥有此关联文本对象的部件中 检查 "Ref10*0" 是否存在。

返回
对象属性引用是否被找到。
在 NX8.5.3 中创建。

许可要求：无
参数
text要查询的关联文本
object对象
attributeTitle对象属性标题

◆ GetObjectAttributeText() [1/2]

NXString NXOpen::Annotations::AssociativeText::GetObjectAttributeText ( NXOpen::NXObject * object,
const char * attributeTitle )

返回输入对象和属性标题的关联文本。

返回
关联文本
在 NX8.0.0 中创建。

许可要求：无
参数
object对象
attributeTitle对象属性标题

◆ GetObjectAttributeText() [2/2]

NXString NXOpen::Annotations::AssociativeText::GetObjectAttributeText ( NXOpen::NXObject * object,
const NXString & attributeTitle )

返回输入对象和属性标题的关联文本。

返回
关联文本
在 NX8.0.0 中创建。

许可要求：无
参数
object对象
attributeTitle对象属性标题

◆ GetObjectAttributeTextFormatted() [1/2]

NXString NXOpen::Annotations::AssociativeText::GetObjectAttributeTextFormatted ( NXOpen::NXObject * object,
const char * attributeTitle,
int decimalPlaces )

返回输入对象和属性标题的格式化关联文本。

返回
关联文本
在 NX2406.0.0 中创建。

许可要求：无
参数
object对象
attributeTitle对象属性标题
decimalPlaces小数格式的小数位数

◆ GetObjectAttributeTextFormatted() [2/2]

NXString NXOpen::Annotations::AssociativeText::GetObjectAttributeTextFormatted ( NXOpen::NXObject * object,
const NXString & attributeTitle,
int decimalPlaces )

返回输入对象和属性标题的格式化关联文本。

返回
关联文本
在 NX2406.0.0 中创建。

许可要求：无
参数
object对象
attributeTitle对象属性标题
decimalPlaces小数格式的小数位数

◆ GetObjectPropertyText()

NXString NXOpen::Annotations::AssociativeText::GetObjectPropertyText ( NXOpen::NXObject * object,
NXOpen::Annotations::AssociativeText::PropertyType type )

返回输入对象及其属性的关联文本。
例如，要获取对图纸名称的引用，对象是 NXOpen::Drawings::DraftingView （属于 NXOpen::Drawings::DrawingSheet ）。 它不是 NXOpen::Drawings::DrawingSheet 本身，而是类型为 NXOpen::Annotations::AssociativeText::PropertyTypeDrawingSheetName 。

返回
关联文本
在 NX8.0.0 中创建。

许可要求：无
参数
object对象
type对象属性

◆ GetPartAttribute() [1/2]

bool NXOpen::Annotations::AssociativeText::GetPartAttribute ( const char * text,
NXString * attributeTitle )

返回关联文本中引用的零件属性标题。 文本引用（如 "Ref2*0" "\<WRef2*0\@title\>"）必须作为零件属性引用存在于拥有该关联文本对象的零件中，才能被视为零件属性。 如果文本控制序列的语法反映了零件属性引用，则认为找到了该引用。 对于不存在的属性引用将返回错误。
示例 1: "\<WRef2*0\@PartAttTitle\>" 是对零件属性 "PartAttTitle" 的现有引用，因此该引用 将被视为零件属性引用。"PartAttTitle" 将作为标题返回。 注意："Ref2*0" 必须作为零件属性引用存在于拥有该关联文本的零件中。

示例 2: "\<W\@AttTitle\>" 使用了零件属性语法，因此该引用将被视为 零件属性引用。"AttTitle" 将作为标题返回。

示例 3: "\<WRef1*0\@ObjAttTitle\>" 是对对象属性 "ObjAttTitle" 的现有引用，因此该引用 将被视为对象属性引用。不会返回任何标题。

示例 4: "\<WRef10*0\@AttTitle\>" 中 "Ref10*0" 引用不存在，将被视为无效的属性引用。 将返回错误。

返回
是否找到零件属性引用
创建于NX8.5.3。

许可要求：无
参数
text包含要查询的关联文本的文本
attributeTitle零件属性标题

◆ GetPartAttribute() [2/2]

bool NXOpen::Annotations::AssociativeText::GetPartAttribute ( const NXString & text,
NXString * attributeTitle )

返回关联文本中引用的零件属性标题。 文本引用（如 "Ref2*0" "\<WRef2*0\@title\>"）必须作为零件属性引用存在于拥有该关联文本对象的零件中，才能被视为零件属性。 如果文本控制序列的语法反映了零件属性引用，则认为找到了该引用。 对于不存在的属性引用将返回错误。
示例 1: "\<WRef2*0\@PartAttTitle\>" 是对零件属性 "PartAttTitle" 的现有引用，因此该引用 将被视为零件属性引用。"PartAttTitle" 将作为标题返回。 注意："Ref2*0" 必须作为零件属性引用存在于拥有该关联文本的零件中。

示例 2: "\<W\@AttTitle\>" 使用了零件属性语法，因此该引用将被视为 零件属性引用。"AttTitle" 将作为标题返回。

示例 3: "\<WRef1*0\@ObjAttTitle\>" 是对对象属性 "ObjAttTitle" 的现有引用，因此该引用 将被视为对象属性引用。不会返回任何标题。

示例 4: "\<WRef10*0\@AttTitle\>" 中 "Ref10*0" 引用不存在，将被视为无效的属性引用。 将返回错误。

返回
是否找到零件属性引用
创建于NX8.5.3。

许可要求：无
参数
text包含要查询的关联文本的文本
attributeTitle零件属性标题

◆ GetPartAttributeText() [1/2]

NXString NXOpen::Annotations::AssociativeText::GetPartAttributeText ( const char * attributeTitle)

返回部件属性标题的关联文本。

返回
关联文本
在 NX8.0.0 中创建。

许可要求：无
参数
attributeTitle部件属性标题

◆ GetPartAttributeText() [2/2]

NXString NXOpen::Annotations::AssociativeText::GetPartAttributeText ( const NXString & attributeTitle)

返回部件属性标题的关联文本。

返回
关联文本
在 NX8.0.0 中创建。

许可要求：无
参数
attributeTitle部件属性标题

◆ GetPartAttributeTextFormatted() [1/2]

NXString NXOpen::Annotations::AssociativeText::GetPartAttributeTextFormatted ( const char * attributeTitle,
int decimalPlaces )

返回零件属性标题的格式化关联文本。

返回
关联文本
创建于NX2406.0.0。

许可要求：无
参数
attributeTitle零件属性标题
decimalPlaces小数格式的小数位数

◆ GetPartAttributeTextFormatted() [2/2]

NXString NXOpen::Annotations::AssociativeText::GetPartAttributeTextFormatted ( const NXString & attributeTitle,
int decimalPlaces )

返回部件属性标题的格式化关联文本。

返回
关联文本
在 NX2406.0.0 中创建。

许可要求：无
参数
attributeTitle部件属性标题
decimalPlaces小数格式的小数位数