Header menu logo FSharp.Data

XmlRuntime Type

Static helper methods called from the generated code for working with XML

Static members

Static member Description

XmlRuntime.ConvertArray(xml, nameWithNS, f)

Full Usage: XmlRuntime.ConvertArray(xml, nameWithNS, f)

Parameters:
Returns: 'R[]
xml : XmlElement
nameWithNS : string
f : Func<XmlElement, 'R>
Returns: 'R[]

XmlRuntime.ConvertAsName(xml, nameWithNS, f)

Full Usage: XmlRuntime.ConvertAsName(xml, nameWithNS, f)

Parameters:
Returns: 'R option

Returns Some if the specified XmlElement has the specified name (otherwise None is returned). This is used when the current element can be one of multiple elements.

xml : XmlElement
nameWithNS : string
f : Func<XmlElement, 'R>
Returns: 'R option

XmlRuntime.ConvertOptional(xml, nameWithNS, f)

Full Usage: XmlRuntime.ConvertOptional(xml, nameWithNS, f)

Parameters:
Returns: 'R option
xml : XmlElement
nameWithNS : string
f : Func<XmlElement, 'R>
Returns: 'R option

XmlRuntime.ConvertOptional2(xml, nameWithNS, f)

Full Usage: XmlRuntime.ConvertOptional2(xml, nameWithNS, f)

Parameters:
Returns: 'R option
xml : XmlElement
nameWithNS : string
f : Func<XmlElement, 'R option>
Returns: 'R option

XmlRuntime.CreateRecord(nameWithNS, attributes, elements, cultureStr)

Full Usage: XmlRuntime.CreateRecord(nameWithNS, attributes, elements, cultureStr)

Parameters:
    nameWithNS : string
    attributes : (string * 'a)[]
    elements : (string * obj)[]
    cultureStr : string

Returns: XmlElement
nameWithNS : string
attributes : (string * 'a)[]
elements : (string * obj)[]
cultureStr : string
Returns: XmlElement

XmlRuntime.CreateValue(nameWithNS, value, cultureStr)

Full Usage: XmlRuntime.CreateValue(nameWithNS, value, cultureStr)

Parameters:
    nameWithNS : string
    value : obj
    cultureStr : string

Returns: XmlElement

Creates a XElement with a scalar value and wraps it in a XmlElement

nameWithNS : string
value : obj
cultureStr : string
Returns: XmlElement

XmlRuntime.GetChild(value, nameWithNS)

Full Usage: XmlRuntime.GetChild(value, nameWithNS)

Parameters:
Returns: XmlElement
value : XmlElement
nameWithNS : string
Returns: XmlElement

XmlRuntime.GetJsonValue(xml)

Full Usage: XmlRuntime.GetJsonValue(xml)

Parameters:
Returns: IJsonDocument

Returns the contents of the element as a JsonValue

xml : XmlElement
Returns: IJsonDocument

XmlRuntime.TryGetAttribute(xml, nameWithNS)

Full Usage: XmlRuntime.TryGetAttribute(xml, nameWithNS)

Parameters:
Returns: string option
xml : XmlElement
nameWithNS : string
Returns: string option

XmlRuntime.TryGetJsonValue(xml)

Full Usage: XmlRuntime.TryGetJsonValue(xml)

Parameters:
Returns: IJsonDocument option

Tries to return the contents of the element as a JsonValue

xml : XmlElement
Returns: IJsonDocument option

XmlRuntime.TryGetValue(xml)

Full Usage: XmlRuntime.TryGetValue(xml)

Parameters:
Returns: string option
xml : XmlElement
Returns: string option

Type something to start searching.