SmartPasteBehavior.ItemDescription Attached Property

Specifies a string that describes the expected content and/or data format for the item. This is an attached property.

Namespace: DevExpress.AIIntegration.Wpf

Assembly: DevExpress.AIIntegration.Wpf.v25.1.dll

NuGet Package: DevExpress.AIIntegration.Wpf

Declaration

See GetItemDescription(DependencyObject) and SetItemDescription(DependencyObject, String).

Returns

Type	Description
String	A string that describes the expected content and/or data format for the item.

Remarks

Note

Item descriptions are optional if a layout item’s Label or a column’s FieldName property is set to a non-empty string. Although SmartPaste attempts to determine the right value for an item based on the item’s name or field name, we recommend that you also describe items for improved accuracy.

Use the ItemDescription attached property or SetItemDescription method to specify a string that describes the expected content and/or data format for the item.

<dxg:GridColumn FieldName="ShippingDate"
                dxai:SmartPasteBehavior.ItemDescription="The date when an order is scheduled to be shipped."/>

When pasting into data fields of basic data types (such as Boolean, date-time, numeric, string), SmartPaste automatically appends default formatting prompts to item descriptions. You can use item descriptions to specify custom formatting prompts as needed.

For example, if your data source designates Boolean values as 1 and -1, you can specify the following item description: “If 1 use True. If -1 use False.”

<dxg:GridColumn FieldName="Shipped"
            dxai:SmartPasteBehavior.ItemDescription="If 1 use True. If -1 use False."/>