[Integration Kit Contents] [Integration Kit What's New] [Integration Kit Function Index] [More Documentation] [PTC]

Info Attributes

Info Attributes provide a means to attach text strings to any Annotator element, e.g. drawing, sheets, views, dimensions, symbols, texts, geometry.

Current info attributes are attached automatically to every subsequently created Annotation element.

Individual info attributes can be attached to any existing Annotation element. The accumulated list of individual info attribute values from all elements in the drawing can be accessed as a global info attributes list, which provides the ability of global attributes changes on all Annotation elements in a drawing.

Info attribute strings beginning with "SD_", "AM_", "DOCU_", "TR" or "RC" are reserved for internal use, so these info attributes are ignored.

Current Info Attributes:
sd-am-inq-curr-info-attributes
sd-am-add-curr-info-attributes
sd-am-change-curr-info-attribute
sd-am-delete-all-curr-info-attributes

Individual Info Attributes:
sd-am-inq-info-attributes
sd-am-add-info-attributes
sd-am-change-info-attribute
sd-am-delete-all-info-attributes

Global Info Attributes:
sd-am-inq-global-info-attributes
sd-am-change-global-info-attribute
sd-am-delete-all-global-info-attributes

Function Index Top of Page

SD-AM-INQ-CURR-INFO-ATTRIBUTES  [function]

(sd-am-inq-curr-info-attributes)
Description:
Inquires the current info attribute strings which are attached automatically to every subsequently created annotation element.
Parameters:
Return Value:
{LIST of STRINGs} - The list of all current info attributes.

Function Index Top of Page

SD-AM-ADD-CURR-INFO-ATTRIBUTES  [function]

(sd-am-add-curr-info-attributes attributes)
Description:
Adds new info attributes to the current info attributes which are attached automatically to every subsequently created annotation element.
Parameters:
attributes {LIST of STRINGs} - The info attributes to be added.
Return Value:

Function Index Top of Page

SD-AM-CHANGE-CURR-INFO-ATTRIBUTE  [function]

(sd-am-change-curr-info-attribute old new)
Description:
Changes the given old current info attribute value to the new value. If the new string is empty, the info attribute is deleted.
Parameters:
old {STRING} - The current info attribute string to be changed.
new {STRING} - The new string to replace the old string.
Return Value:
t - The old current info attribute string was found and changed.
nil - The old current info attribute string was not found.

Function Index Top of Page

SD-AM-DELETE-ALL-CURR-INFO-ATTRIBUTES  [function]

(sd-am-delete-all-curr-info-attributes)
Description:
Deletes all current info attribute strings.
Parameters:
Return Value:

Function Index Top of Page

SD-AM-INQ-INFO-ATTRIBUTES  [function]

(sd-am-inq-info-attributes item)
Description:
Inquires all info attribute strings attached to the given item.
Parameters:
item {SEL_ITEM} - The item to inquire the info attributes from. Item can be any Annotator item, i.e. drawing, sheets, views, dimensions, symbols, texts or geometry.
Return Value:
attributes {LIST of STRINGs} - The inquired info attribute strings.

Function Index Top of Page

SD-AM-ADD-INFO-ATTRIBUTES  [function]

(sd-am-add-info-attributes attributes item)
Description:
Adds new info attributes to the given item.
Parameters:
attributes {LIST of STRINGs} - The info attributes to be added.
item {SEL_ITEM} - The item to inquire the info attributes from. Item can be any Annotator item, i.e. drawing, sheets, views, dimensions, symbols, texts or geometry.
Return Value:

Function Index Top of Page

SD-AM-CHANGE-INFO-ATTRIBUTE  [function]

(sd-am-change-info-attribute old new item)
Description:
Changes the given old info attribute value to the new value. If the new string is empty, the info attribute is deleted.
Parameters:
old {STRING} - The info attribute string to be changed.
new {STRING} - The new string to replace the old string.
item {SEL_ITEM} - The item to change the info attributes. Item can be any Annotator item, i.e. drawing, sheets, views, dimensions, symbols, texts or geometry.
Return Value:
t - The old info attribute string was found and changed.
nil - The old info attribute string was not found.

Function Index Top of Page

SD-AM-DELETE-ALL-INFO-ATTRIBUTES  [function]

(sd-am-delete-all-info-attributes item)
Description:
Deletes all info attributes from the given item.
Parameters:
item {SEL_ITEM} - The item to change the info attributes. Item can be any Annotator item, i.e. drawing, sheets, views, dimensions, symbols, texts or geometry.
Return Value:

Function Index Top of Page

SD-AM-INQ-GLOBAL-INFO-ATTRIBUTES  [function]

(sd-am-inq-global-info-attributes)
Description:
Inquires all info attribute strings currently attached to any item in the drawing.
Parameters:
Return Value:
{LIST of STRINGs} - The inquired info attribute strings.

Function Index Top of Page

SD-AM-CHANGE-GLOBAL-INFO-ATTRIBUTE  [function]

(sd-am-change-global-info-attribute old new)
Description:
Changes the given old info attribute value to the new value for all items in the drawing.
Parameters:
old {STRING} - The info attribute string to be changed.
new {STRING} - The new string to replace the old string.
Return Value:
t - The old info attribute string was found and changed.
nil - The old info attribute string was not found.

Function Index Top of Page

SD-AM-DELETE-ALL-GLOBAL-INFO-ATTRIBUTES  [function]

(sd-am-delete-all-global-info-attributes)
Description:
Deletes all info attributes in the drawing.
Parameters:
Return Value:
[Integration Kit Contents] [Integration Kit What's New] [Integration Kit Function Index] [More Documentation] [PTC]
© 2019 Parametric Technology GmbH
(a subsidiary of PTC Inc.), All Rights Reserved