Writes a new value for an existing property that belongs to any non-standard property set. The property can be specified using either the display name or the internal name. If treatAsDate? is True , the supplied string value is treated as a date value. If createNew? is True , a new property is added to the pre-defined "User Defined Properties" property set.
Similar to iv_PropertyPut(), but operates on the document handle (or occurrence handle for virtual components).
iv_documentPropertyPut ( documentHandle As String, _
propertyName As String, _
value As Any, _
Optional createNew? As Boolean = False, _
Optional treatAsDate? As Boolean = False ) As Any
Argument | Type | Description |
---|---|---|
documentHandle | string | Handle of the Inventor document owning the property. |
propertyName | string | Name of the Property. |
value | any | Value of the Property. |
createNew? | boolean | Optional; if True , create a new property. The property is created as a user property; default is False |
treatAsDate? | boolean | Optional; if True , interpret the value as a date; default is False . |
Set property value
Intent >iv_documentPropertyGet(%%Document, "Author")
--> "korzuna"
Intent >iv_documentPropertyPut(%%Document, "Author", "nelsont")
--> "nelsont"
Intent >iv_documentPropertyGet(%%Document, "Author")
--> "nelsont"