Office.AddBindingFromPromptOptions interface
Provides options for configuring the prompt and identifying the binding that is created.
Properties
| async |
A user-defined item of any type that is returned, unchanged, in the asyncContext property of the AsyncResult object that is passed to a callback. |
| id | The unique ID of the binding. Autogenerated if not supplied. |
| prompt |
Specifies the string to display in the prompt UI that tells the user what to select. Limited to 200 characters. If no promptText argument is passed, "Please make a selection" is displayed. |
| sample |
Specifies a table of sample data displayed in the prompt UI as an example of the kinds of fields (columns) that can be bound by your add-in. The headers provided in the TableData object specify the labels used in the field selection UI. Note: This parameter is used only in add-ins for Access. It is ignored if provided when calling the method in an add-in for Excel. |
Property Details
asyncContext
A user-defined item of any type that is returned, unchanged, in the asyncContext property of the AsyncResult object that is passed to a callback.
asyncContext?: anyProperty Value
any
id
The unique ID of the binding. Autogenerated if not supplied.
id?: stringProperty Value
string
promptText
Specifies the string to display in the prompt UI that tells the user what to select. Limited to 200 characters. If no promptText argument is passed, "Please make a selection" is displayed.
promptText?: stringProperty Value
string
sampleData
Warning
This API is now deprecated.
Microsoft Access is no longer supported.
Specifies a table of sample data displayed in the prompt UI as an example of the kinds of fields (columns) that can be bound by your add-in. The headers provided in the TableData object specify the labels used in the field selection UI.
Note: This parameter is used only in add-ins for Access. It is ignored if provided when calling the method in an add-in for Excel.
sampleData?: Office.TableData