scintillaExtenderFormatHelpTip Method |
Formats the text to be displayed in the tooltip using information from the object's member and from the XML documentation, if existing.
Namespace: DWSIM.UnitOperationsAssembly: DWSIM.UnitOperations (in DWSIM.UnitOperations.dll) Version: 8.8.1.0
Syntax private static string FormatHelpTip(
this Scintilla scintilla,
MemberInfo member,
List<XmlDocCommentReader> reader,
bool capeopen
)
<ExtensionAttribute>
Private Shared Function FormatHelpTip (
scintilla As Scintilla,
member As MemberInfo,
reader As List(Of XmlDocCommentReader),
capeopen As Boolean
) As String
Request Example
View SourceParameters
- scintilla Scintilla
- member MemberInfo
- Reflected member to display information from.
- reader ListXmlDocCommentReader
- Jolt's XmlDocCommentReader instance, to get and display comments from assembly-generated XML file.
- capeopen Boolean
-
Return Value
StringThe formatted text to display in the tooltip.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
Scintilla. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
See Also