DataItems.Add method - Developer Area

API Documentation > Corel DESIGNER > 2022-v24.2 > DataItems > IVGDataItems

DataItems.Add method

Adds a field

Syntax:

Function Add(ByVal DataField As DataField, Optional ByVal Value As Variant) As DataItem

Parameters:

Name	Type	Description
DataField	DataField	Specifies the data field. A data field is a single property or value associated with a DataItem object.
Value	Variant	Associates a value for the new data field.

Remarks:

The Add method adds a new data field to a shape and optionally specifies its value.

If a data field is not a document default and is empty for the current shape, it is not listed in the shape's DataItems collection - that is, it is not returned by the ObjectData property. In this case, the Add method is the only way to set some value to that field. If the field is already listed in the collection, the Add method returns the reference to its data item.

Examples:

The following VBA example adds a new data field with name Weight to the active shape and specifies its value as 6. The Weight field must already be defined in the current document.

Sub Test()
  Dim df As DataField
  Dim di As DataItem
  Set df = ActiveDocument.DataFields.Add("Weight1")
  Set di = ActiveShape.ObjectData.Add(df)
  di.Value = 6
End Sub

The following VBA example adds a data field and specifies its value as 10.

Sub Test()
  Dim df As DataField
  Dim di As DataItem
  Set df = ActiveDocument.DataFields.Add("Weight2")
  Set di = ActiveShape.ObjectData.Add(df, 10)
  MsgBox "The new value of '" & df.Name & "' field is " & di.FormattedValue
End Sub

Version Information:

CorelDRAW:	X7.4, X7, X7.6, X8, 2017, 2018, 2019, 2019.2, 2020, 2021, 2020.1, 2021.5, 2022-v24, 2022-v24.1, 2022-v24.2, 2023-v24.3, 2023-v24.5, 2024-v25
Corel DESIGNER:	X7, 2017.1, 20.1, 2019.2, 2020.1, 2021.5, 2022-v24, 2022-v24.1, 2022-v24.2, 2023-v24.3, 2023-v24.5, 2024-v25