Header menu logo FSharp.Data

HtmlDocumentExtensions Type

Static members

Static member Description

HtmlDocumentExtensions.Body(doc)

Full Usage: HtmlDocumentExtensions.Body(doc)

Parameters:
Returns: HtmlNode

Finds the body element of the given document, this throws an exception if no body element exists.

doc : HtmlDocument
Returns: HtmlNode

HtmlDocumentExtensions.Descendants(doc, name)

Full Usage: HtmlDocumentExtensions.Descendants(doc, name)

Parameters:
    doc : HtmlDocument - The given document
    name : string - The name to match

Returns: HtmlNode seq

Finds all of the descendant nodes of this document that match the given name Recurses on match

doc : HtmlDocument

The given document

name : string

The name to match

Returns: HtmlNode seq

HtmlDocumentExtensions.Descendants(doc, name, recurseOnMatch)

Full Usage: HtmlDocumentExtensions.Descendants(doc, name, recurseOnMatch)

Parameters:
    doc : HtmlDocument - The given document
    name : string - The name to match
    recurseOnMatch : bool - If a match is found continues down the tree matching child elements

Returns: HtmlNode seq

Finds all of the descendant nodes of this document that match the given name

doc : HtmlDocument

The given document

name : string

The name to match

recurseOnMatch : bool

If a match is found continues down the tree matching child elements

Returns: HtmlNode seq

HtmlDocumentExtensions.Descendants(doc, names)

Full Usage: HtmlDocumentExtensions.Descendants(doc, names)

Parameters:
    doc : HtmlDocument - The given document
    names : string seq - The set of names to match

Returns: HtmlNode seq

Finds all of the descendant nodes of this document that match the given set of names Recurses on match

doc : HtmlDocument

The given document

names : string seq

The set of names to match

Returns: HtmlNode seq

HtmlDocumentExtensions.Descendants(doc, names, recurseOnMatch)

Full Usage: HtmlDocumentExtensions.Descendants(doc, names, recurseOnMatch)

Parameters:
    doc : HtmlDocument - The given document
    names : string seq - The set of names to match
    recurseOnMatch : bool - If a match is found continues down the tree matching child elements

Returns: HtmlNode seq

Finds all of the descendant nodes of this document that match the given set of names

doc : HtmlDocument

The given document

names : string seq

The set of names to match

recurseOnMatch : bool

If a match is found continues down the tree matching child elements

Returns: HtmlNode seq

HtmlDocumentExtensions.Descendants(doc)

Full Usage: HtmlDocumentExtensions.Descendants(doc)

Parameters:
Returns: HtmlNode seq

Gets all of the descendants of this document Recurses on match

doc : HtmlDocument
Returns: HtmlNode seq

HtmlDocumentExtensions.Descendants(doc, predicate)

Full Usage: HtmlDocumentExtensions.Descendants(doc, predicate)

Parameters:
    doc : HtmlDocument - The given document
    predicate : HtmlNode -> bool - The predicate by which to match the nodes to return

Returns: HtmlNode seq

Gets all of the descendants of this document that statisfy the given predicate Recurses on match

doc : HtmlDocument

The given document

predicate : HtmlNode -> bool

The predicate by which to match the nodes to return

Returns: HtmlNode seq

HtmlDocumentExtensions.Descendants(doc, predicate, recurseOnMatch)

Full Usage: HtmlDocumentExtensions.Descendants(doc, predicate, recurseOnMatch)

Parameters:
    doc : HtmlDocument - The given document
    predicate : HtmlNode -> bool - The predicate by which to match the nodes to return
    recurseOnMatch : bool - If a match is found continues down the tree matching child elements

Returns: HtmlNode seq

Gets all of the descendants of this document that statisfy the given predicate

doc : HtmlDocument

The given document

predicate : HtmlNode -> bool

The predicate by which to match the nodes to return

recurseOnMatch : bool

If a match is found continues down the tree matching child elements

Returns: HtmlNode seq

HtmlDocumentExtensions.DescendantsWithPath(doc, name)

Full Usage: HtmlDocumentExtensions.DescendantsWithPath(doc, name)

Parameters:
    doc : HtmlDocument - The given document
    name : string - The name to match

Returns: (HtmlNode * HtmlNode list) seq

Finds all of the descendant nodes of this document that match the given name Recurses on match

doc : HtmlDocument

The given document

name : string

The name to match

Returns: (HtmlNode * HtmlNode list) seq

HtmlDocumentExtensions.DescendantsWithPath(doc, name, recurseOnMatch)

Full Usage: HtmlDocumentExtensions.DescendantsWithPath(doc, name, recurseOnMatch)

Parameters:
    doc : HtmlDocument - The given document
    name : string - The name to match
    recurseOnMatch : bool - If a match is found continues down the tree matching child elements

Returns: (HtmlNode * HtmlNode list) seq

Finds all of the descendant nodes of this document that match the given name

doc : HtmlDocument

The given document

name : string

The name to match

recurseOnMatch : bool

If a match is found continues down the tree matching child elements

Returns: (HtmlNode * HtmlNode list) seq

HtmlDocumentExtensions.DescendantsWithPath(doc, names)

Full Usage: HtmlDocumentExtensions.DescendantsWithPath(doc, names)

Parameters:
    doc : HtmlDocument - The given document
    names : string seq - The set of names to match

Returns: (HtmlNode * HtmlNode list) seq

Finds all of the descendant nodes of this document that match the given set of names Recurses on match

doc : HtmlDocument

The given document

names : string seq

The set of names to match

Returns: (HtmlNode * HtmlNode list) seq

HtmlDocumentExtensions.DescendantsWithPath(doc, names, recurseOnMatch)

Full Usage: HtmlDocumentExtensions.DescendantsWithPath(doc, names, recurseOnMatch)

Parameters:
    doc : HtmlDocument - The given document
    names : string seq - The set of names to match
    recurseOnMatch : bool - If a match is found continues down the tree matching child elements

Returns: (HtmlNode * HtmlNode list) seq

Finds all of the descendant nodes of this document that match the given set of names

doc : HtmlDocument

The given document

names : string seq

The set of names to match

recurseOnMatch : bool

If a match is found continues down the tree matching child elements

Returns: (HtmlNode * HtmlNode list) seq

HtmlDocumentExtensions.DescendantsWithPath(doc)

Full Usage: HtmlDocumentExtensions.DescendantsWithPath(doc)

Parameters:
Returns: (HtmlNode * HtmlNode list) seq

Gets all of the descendants of this document Recurses on match

doc : HtmlDocument
Returns: (HtmlNode * HtmlNode list) seq

HtmlDocumentExtensions.DescendantsWithPath(doc, predicate)

Full Usage: HtmlDocumentExtensions.DescendantsWithPath(doc, predicate)

Parameters:
    doc : HtmlDocument - The given document
    predicate : HtmlNode -> bool - The predicate by which to match the nodes to return

Returns: (HtmlNode * HtmlNode list) seq

Gets all of the descendants of this document that statisfy the given predicate Recurses on match

doc : HtmlDocument

The given document

predicate : HtmlNode -> bool

The predicate by which to match the nodes to return

Returns: (HtmlNode * HtmlNode list) seq

HtmlDocumentExtensions.DescendantsWithPath(doc, predicate, recurseOnMatch)

Full Usage: HtmlDocumentExtensions.DescendantsWithPath(doc, predicate, recurseOnMatch)

Parameters:
    doc : HtmlDocument - The given document
    predicate : HtmlNode -> bool - The predicate by which to match the nodes to return
    recurseOnMatch : bool - If a match is found continues down the tree matching child elements

Returns: (HtmlNode * HtmlNode list) seq

Gets all of the descendants of this document that statisfy the given predicate

doc : HtmlDocument

The given document

predicate : HtmlNode -> bool

The predicate by which to match the nodes to return

recurseOnMatch : bool

If a match is found continues down the tree matching child elements

Returns: (HtmlNode * HtmlNode list) seq

HtmlDocumentExtensions.Elements(doc, name)

Full Usage: HtmlDocumentExtensions.Elements(doc, name)

Parameters:
    doc : HtmlDocument - The given document
    name : string - The name to match

Returns: HtmlNode list

Returns all of the root elements in the current document that match the name

doc : HtmlDocument

The given document

name : string

The name to match

Returns: HtmlNode list

HtmlDocumentExtensions.Elements(doc, names)

Full Usage: HtmlDocumentExtensions.Elements(doc, names)

Parameters:
    doc : HtmlDocument - The given document
    names : string seq - The set of names to match

Returns: HtmlNode list

Returns all of the root elements in the current document that match the set of names

doc : HtmlDocument

The given document

names : string seq

The set of names to match

Returns: HtmlNode list

HtmlDocumentExtensions.Elements(doc)

Full Usage: HtmlDocumentExtensions.Elements(doc)

Parameters:
Returns: HtmlNode list

Returns all of the root elements of the current document

doc : HtmlDocument

The given document

Returns: HtmlNode list

HtmlDocumentExtensions.Html(doc)

Full Usage: HtmlDocumentExtensions.Html(doc)

Parameters:
Returns: HtmlNode

Finds the html element of the given document, this throws an exception if no html element exists.

doc : HtmlDocument
Returns: HtmlNode

HtmlDocumentExtensions.TryGetBody(doc)

Full Usage: HtmlDocumentExtensions.TryGetBody(doc)

Parameters:
Returns: HtmlNode option

Tries to find the body element of the given document.

doc : HtmlDocument
Returns: HtmlNode option

HtmlDocumentExtensions.TryGetHtml(doc)

Full Usage: HtmlDocumentExtensions.TryGetHtml(doc)

Parameters:
Returns: HtmlNode option

Tries to find the html element of the given document.

doc : HtmlDocument
Returns: HtmlNode option

Type something to start searching.