Adding tool tip for fields in format pane

[Anonymous]

We wanted to add a user friendly message to an input box in the formate pane which was added to our custom visual. We did specify description along in the property but is dosen't seem to appear any where. Can we add a tool tip / friendly message for input boxes in the formate pane.

[dm-p · Accepted solution]

Hi @Anonymous,

Assuming I'm reading this right, do you mean a message in the property tooltip, like this?

If so, then you indeed just need to add a description property to your object declaration. I note that you say you've done this, but I'll just include what I did for reference so that you can cross-check:

    ...
    "myTextProperty": {
        "displayName": "My Text Property",
        "description": "This should be a user friendly message...",
        "type": {
            "text": true
        }
    }
    ...

If this is how you've set it up at your end, we might need a bit more info to assist, but this is all I've ever had to do.

Regards,

Daniel

---

P.S. While we're on the subject, it might be handy to know that you can also use the JavaScript string escape sequences (such as \n and \t) in these properties, as well as unicode, e.g.:

    ...
    "myTextProperty": {
        "displayName": "My Text Property",
        "description": "This should be a user friendly message...\n\nAnd this is a new paragraph within the tooltip\n\n\t• This kind of looks like a bullet\n\nAnd now we're back to normal ",
        "type": {
            "text": true
        }
    }
    ...

(the forum's code formatter seems to strip out the emoji but it is in the code I pasted)

HTML won't work in here though, so if you want to get fancy, you have to work with the above.

[Anonymous]

Thank you. It worked but we are getting tooltip only on hover over the label. Can we get it when we hover over the input box ?

Or Is there a way to show the message below the input box. Similar as a label