RibbonBarButton Class

Represents a Ribbonbar button.

Inheritance Hierarchy

System.Web.UIControl
Dynamicweb.ControlsRibbonBarItem
Dynamicweb.ControlsRibbonBarButton

Namespace: Dynamicweb.Controls
Assembly: Dynamicweb.Controls (in Dynamicweb.Controls.dll) Version: 4.2.3

Syntax

Copy

[DefaultPropertyAttribute("Text")]
public class RibbonBarButton : RibbonBarItem, 
	IPostBackEventHandler

<DefaultPropertyAttribute("Text")>
Public Class RibbonBarButton
	Inherits RibbonBarItem
	Implements IPostBackEventHandler

The RibbonBarButton type exposes the following members.

Constructors

	Name	Description
	RibbonBarButton	Initializes a new instance of the RibbonBarButton class

Top

Properties

	Name	Description
	Active	Stores and retrieves the value indicating whether button is active (highlighted).
	ContextMenuId	ID of contextmenu linked to this button.
	CssClass	Gets or sets the additional CSS class name to apply.
	Disabled	Stores and retrieves the value indicating whether button is disabled.
	DoTranslate	If set to true (default) the Text is translated
	EnableServerClick	Gets or sets value indicating whether to raize postback 'OnClick' event for this button.
	Hide	Stores and retrieves the value indicating whether not to show the button.
	Icon	Stores and retrieves the predefined button icon. Icons wins over images!
	IconColor
	Image	Stores and retrieves the predefined button image.
	ImagePath	Stores and retrieves the path to the button image.
	IndependentRenderingInGroup	If set to true item should render self in group independently (Inherited from RibbonBarItem.)
	KeyboardShortcut	Gets or sets the keboard shortcut for button
	ModuleSystemName	Get and set required module to see this item
	NgClick
	OnClientClick	Gets or sets the client-side script which is executed when user clicks on a button.
	PerformValidation	Gets or sets a value indicating whether to perform post back validation.
	ShowWait	Gets or sets a value indicating whether a wait overlay will be displayed when button is clicked.
	Size	Stores and retrieves the size of the button image.
	SplitButton
	Text	Stores and retrieves button text.
	Title
	Version	Get and set minimum required version to use the button
	WaitMessage	Gets or sets the wait message to show when button is pressed if ShowWait is enabled.
	WaitTimeout	Gets or sets the wait timeout in ms.

Top

Methods

	Name	Description
	KeyboardShortcutAppend	Appends keyboard shortcut to a ribbon bar item (Inherited from RibbonBarItem.)
	LoadPostData	Processes postback data for the item. (Inherited from RibbonBarItem.)
	RaisePostBackEvent	Enables a button to process an event raised when a form is posted to the server.
	RaisePostDataChangedEvent	Signals the item to notify the ASP.NET application that the state of the item has changed. (Inherited from RibbonBarItem.)
	RaisesEvent(String)	Determines whether the item is currently raising specified event. (Inherited from RibbonBarItem.)
	RaisesEvent(String, String)	Determines whether the item is currently raising specified event. (Inherited from RibbonBarItem.)
	RenderControl	Renders button.

Top

Events

	Name	Description
	Click	Server-side "OnClick" event.

Top

Remarks

Reference

Dynamicweb.Controls Namespace