OnClickFunctionName Property

Gets or sets the JavaScript function call that is made when the ToolbarButton is clicked.

[Visual Basic]
<DefaultValueAttribute()>
<DescriptionAttribute("The client side function to call when the button is clicked.")>
Public Property OnClickFunctionName As String

[C#]
[DefaultValueAttribute()]
[DescriptionAttribute("The client side function to call when the button is clicked.")]
public string OnClickFunctionName {get; set;}

[C++]
[DefaultValueAttribute()]
[DescriptionAttribute("The client side function to call when the button is clicked.")]
public: __property string* get_OnClickFunctionName();
public: __property void set_OnClickFunctionName( 
   string* value
);

[C++/CLI]
[DefaultValueAttribute()]
[DescriptionAttribute("The client side function to call when the button is clicked.")]
public:
property String^ OnClickFunctionName {
   String^ get();
   void set (String^ value);
}

Return Type

A string containing the JavaScript function that is called when the ToolbarButton is clicked.

Remarks

By default, with predefined types (i.e. all types in the ToolbarButtonType enumeration with the exception of Custom), this property will be set to the proper value during initialization. For example, if the ToolbarButton created is of type ToolbarButtonType.Bold, this property will return "pwFormatBold()", indicating that it will call the client-side script to format the selected text as bold. This property should ONLY be set in the case of ToolbarButtonType.Custom, in which this property will be an empty string until properly set by the developer. In this case, you can set the ToolbarButton.OnClickFunctionCode property to the code block called when the button is clicked, for example:

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows ME, Windows 2000, Windows XP, Windows Server 2003, Windows Vista

See Also

ToolbarButton Class  | ToolbarButton Members