ICustomFormatter Interface

Defines a method that supports custom, user-defined formatting of the value of an object.

Namespace: System
Assembly: mscorlib (in mscorlib.dll)

public interface ICustomFormatter
/** @attribute ComVisibleAttribute(true) */ 
public interface ICustomFormatter
public interface ICustomFormatter

When this interface is implemented by a reference or value type, the Format method returns a custom-formatted string representation of an object's value.

Use this interface, and the IFormatProvider interface, to supersede the support supplied in .NET Framework formatting methods that honor an IFormatProvider parameter. For example, use this interface to provide custom formatting of the value of an object by the String.Format or Int32.ToString methods.

Derive a class that implements the IFormatProvider interface and its GetFormat method. Specify that derived class for the IFormatProvider parameter of the method you want to supersede. Your implementation of the GetFormat method should return a format object that implements the ICustomFormatter interface. The .NET Framework method will then use your custom formatting instead of its own.

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0