ToolTipElement (F# Compiler Guide) | F# Compiler Guide

F# Compiler Guide

ToolTipElement Type

Namespace: FSharp.Compiler.EditorServices
Assembly: FSharp.Compiler.Service.dll
Base Type: obj
All Interfaces: IStructuralEquatable

A single tool tip display element

Union cases

Union case	Description
`CompositionError errorText` Full Usage: `CompositionError errorText` Parameters: errorText : `string`	An error occurred formatting this element errorText : `string`
`Group elements` Full Usage: `Group elements` Parameters: elements : `ToolTipElementData list`	A single type, method, etc with comment. May represent a method overload group. elements : `ToolTipElementData list`
`None` Full Usage: `None`

Instance members

Instance member	Description
`this.IsCompositionError` Full Usage: `this.IsCompositionError` Returns: `bool`	Returns: `bool`
`this.IsGroup` Full Usage: `this.IsGroup` Returns: `bool`	Returns: `bool`
`this.IsNone` Full Usage: `this.IsNone` Returns: `bool`	Returns: `bool`

Static members

Static member	Description
`ToolTipElement.Single(layout, xml, ?typeMapping, ?paramName, ?remarks, ?symbol)` Full Usage: `ToolTipElement.Single(layout, xml, ?typeMapping, ?paramName, ?remarks, ?symbol)` Parameters: layout : `TaggedText[]` xml : `FSharpXmlDoc` ?typeMapping : `TaggedText[] list` ?paramName : `string` ?remarks : `TaggedText[]` ?symbol : `FSharpSymbol` Returns: `ToolTipElement`	layout : `TaggedText[]` xml : `FSharpXmlDoc` ?typeMapping : `TaggedText[] list` ?paramName : `string` ?remarks : `TaggedText[]` ?symbol : `FSharpSymbol` Returns: `ToolTipElement`