ObjectFormatter Class

Represents a string formatter. Exposes the static helper ObjectFormatter.Format method that replaces format items in the specified string with the property values of the specified object.

Namespace: DevExpress.Persistent.Base

Assembly: DevExpress.ExpressApp.v22.1.dll

Declaration

C#

public class ObjectFormatter :
    ICustomFormatter,
    IFormatProvider

VB.NET

Public Class ObjectFormatter
    Implements ICustomFormatter,
               IFormatProvider

Remarks

The ObjectFormatter is an auxiliary class that exposes the ObjectFormatter.Format method. This method can be used to create calculated properties in persistent classes. It takes an object and a string that contains format items. The method treats all the format items as the property names of the object. It replaces all the format items in the passed string with property values of the passed object.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ObjectFormatter class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XAF_how-to-use-the-calculatedpersistentalias-attribute-e1771/CS/CalculatedAlias.Module/Product.cs#L23

public string ProductName {
    get { return ObjectFormatter.Format(productNameFormat, this, EmptyEntriesMode.RemoveDelimiterWhenEntryIsEmpty); }
}

VB.NET

XAF_how-to-use-the-calculatedpersistentalias-attribute-e1771/VB/CalculatedAlias.Module/Product.vb#L29

Get
    Return ObjectFormatter.Format(productNameFormat, Me, EmptyEntriesMode.RemoveDelimiterWhenEntryIsEmpty)
End Get

Inheritance

Object

ObjectFormatter