RibbonBarAppButton

Namespace: Wisej.Web.Ext.RibbonBar

Assembly: Wisej.Web.Ext.RibbonBar (4.1.0.0)

• Component
  • Component
    • RibbonBarAppButton

Represents the main application button in a RibbonBar displayed before the first RibbonBarPage.

C#

public class RibbonBarAppButton : Component

VB.NET

Public Class RibbonBarAppButton
    Inherits Component

The single instance is created by the RibbonBar and is accessible through the AppButton property. It's hidden by default. When the user clicks the button, the RibbonBar fires the AppButtonClick event.

Properties

BackColor

Color: Returns or sets the background color of the RibbonBarAppButton tab button. (Default: Color [Empty])

Value: The background Color of the button. The default is Empty, which uses the color defined in the theme.

ForeColor

Color: Returns or sets the text color of the RibbonBarAppButton tab button. (Default: Color [Empty])

Value: The text Color of the button. The default is Empty, which uses the color defined in the theme.

Image

Image: Returns or sets the image that is displayed in the RibbonBarAppButton.

Value: The Image displayed in the RibbonBarAppButton. The default value is null.

ImageIndex

Int32: Returns or sets the index value of the image assigned to the RibbonBarAppButton. (Default: -1)

Value: The index value of the Image assigned to the RibbonBarAppButton. The default is -1.

The index refers to an image in the ImageList of the owner RibbonBar.

Throws:

• ArgumentOutOfRangeException The specified index is less than -1.

ImageKey

String: Returns or sets the name of the image assigned to the RibbonBarAppButton. (Default: "")

Value: The name of the Image assigned to the RibbonBarAppButton.

The key refers to an image in the ImageList of the owner RibbonBar.

ImageSource

String: Returns or sets the theme name or URL for the image to display in the RibbonBarAppButton.

Value: The theme name or URL for the image to display in the RibbonBarAppButton.

Example:

Showing the application button with an icon:

this.ribbonBar1.AppButton.ImageSource = "Images/logo.png";
this.ribbonBar1.AppButton.Visible = true;

Parent

RibbonBar: Returns the RibbonBar that owns this RibbonBarAppButton.

RibbonBar

RibbonBar: Returns the RibbonBar that contains this RibbonBarAppButton.

Text

String: Returns or sets the text of the RibbonBarAppButton. (Default: "")

Value: The text displayed in the RibbonBarAppButton.

ToolTipText

String: Returns or sets the tooltip text for the RibbonBarAppButton. (Default: "")

Value: The text displayed in a tooltip for the RibbonBarAppButton.

Visible

Boolean: Returns or sets whether the RibbonBarAppButton is visible or hidden. (Default: False)

Value: true if the application button is visible; otherwise, false. The default is false.

The application button is hidden by default and the AppButtonClick event is fired only while the button is visible.

Methods

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

Update()

Updates the component on the client.

Changing the properties of the button already updates the client. At design time the owner RibbonBar is refreshed as well.

Example:

Forcing the application button to be updated on the client:

this.ribbonBar1.AppButton.Update();

Implements

Name	Description
IUserData
IWisejComponent
IWisejSerializable