FSharp.Data.Toolbox


ProvidedField Type

Represents an erased provided field.

Constructors

Constructor Description

ProvidedField(fieldName, fieldType)

Full Usage: ProvidedField(fieldName, fieldType)

Parameters:
    fieldName : string
    fieldType : Type

Returns: ProvidedField

Create a new provided field. It is not initially associated with any specific provided type definition.

fieldName : string
fieldType : Type
Returns: ProvidedField

Instance members

Instance member Description

this.AddCustomAttribute(arg1)

Full Usage: this.AddCustomAttribute(arg1)

Parameters:

Add a custom attribute to the provided property definition.

arg0 : CustomAttributeData

this.AddDefinitionLocation(line, column, filePath)

Full Usage: this.AddDefinitionLocation(line, column, filePath)

Parameters:
    line : int
    column : int
    filePath : string

Add definition location information to the provided field definition.

line : int
column : int
filePath : string

this.AddObsoleteAttribute(message, ?isError)

Full Usage: this.AddObsoleteAttribute(message, ?isError)

Parameters:
    message : string
    ?isError : bool

Add a 'Obsolete' attribute to this provided field

message : string
?isError : bool

this.AddXmlDoc(xmlDoc)

Full Usage: this.AddXmlDoc(xmlDoc)

Parameters:
    xmlDoc : string

Add XML documentation information to this provided field

xmlDoc : string

this.AddXmlDocComputed(xmlDocFunction)

Full Usage: this.AddXmlDocComputed(xmlDocFunction)

Parameters:
    xmlDocFunction : unit -> string

Add XML documentation information to this provided field, where the computation of the documentation is delayed until necessary The documentation is re-computed every time it is required.

xmlDocFunction : unit -> string

this.AddXmlDocDelayed(xmlDocFunction)

Full Usage: this.AddXmlDocDelayed(xmlDocFunction)

Parameters:
    xmlDocFunction : unit -> string

Add XML documentation information to this provided field, where the computation of the documentation is delayed until necessary

xmlDocFunction : unit -> string

this.SetFieldAttributes(attributes)

Full Usage: this.SetFieldAttributes(attributes)

Parameters:

attributes : FieldAttributes

Static members

Static member Description

ProvidedField.Literal(fieldName, fieldType, literalValue)

Full Usage: ProvidedField.Literal(fieldName, fieldType, literalValue)

Parameters:
    fieldName : string
    fieldType : Type
    literalValue : obj

Returns: ProvidedField

Create a new provided literal field. It is not initially associated with any specific provided type definition.

fieldName : string
fieldType : Type
literalValue : obj
Returns: ProvidedField