Core.StructuredFormatDisplayAttribute Class (F#)

  • Article

This attribute is used to mark how a type is displayed by default when using %Aprintf formatting patterns and other two-dimensional text-based display layouts. In this version of F# the only valid values are of the form PreText {PropertyName} PostText. The property name indicates a property to evaluate and to display instead of the object itself.

Namespace/Module Path: Microsoft.FSharp.Core

Assembly: FSharp.Core (in FSharp.Core.dll)

[<AttributeUsage(AttributeTargets.Class ||| AttributeTargets.Interface ||| AttributeTargets.Struct ||| AttributeTargets.Delegate ||| AttributeTargets.Enum, AllowMultiple = false)>]
[<Sealed>]
type StructuredFormatDisplayAttribute =
 class
  new StructuredFormatDisplayAttribute : string -> StructuredFormatDisplayAttribute
  member this.Value :  string
 end

Remarks

You can also use the short form of the name, StructuredFormatDisplay.

Constructors

Member

Description

new

Creates an instance of the attribute

Instance Members

Member

Description

Value

Indicates the text to display by default when objects of this type are displayed using %Aprintf formatting patterns and other two-dimensional text-based display layouts.

Platforms

Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2

Version Information

F# Core Library Versions

Supported in: 2.0, 4.0, Portable

See Also

Reference

Microsoft.FSharp.Core Namespace (F#)