Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Provides data for the ButtonClick event.

public class ToolBarButtonClickEventArgs : EventArgs

Public Class ToolBarButtonClickEventArgs
    Inherits EventArgs

Constructors

ToolBarButtonClickEventArgs(button)

Initializes a new instance of the ToolBarButtonClickEventArgs class.

Properties

Button

ToolBarButton: Returns or sets the ToolBarButton that was clicked.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the collection of ToolBarButton controls in a ToolBar control.

public class ToolBarButtonCollection : IList, ICollection, IEnumerable, IList<ToolBarButton>, ICollection<ToolBarButton>, IEnumerable<ToolBarButton>

Public Class ToolBarButtonCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of ToolBarButton), ICollection(Of ToolBarButton), IEnumerable(Of ToolBarButton)

Constructors

ToolBarButtonCollection(owner)

Initializes a new instance of the ToolBarButtonCollection class.

Properties

IsDirty

Boolean: Returns or sets the dirty state for the list. When true, the list of items must be sent back to the client.

IsNew

Boolean: Returns or sets the new state for the list. When true, the entire list is cleared and reloaded on the client.

IsReadOnly

Boolean: Returns a value indicating whether this collection is read-only.

ToolBarButton: Returns or sets the ToolBarButton at the specified index.

ToolBarButton: Returns the ToolBarButton identified by the name.

Methods

Adds a ToolBarButton with the specified text to the collection.

Returns: ToolBarButton. A ToolBarButton that represents the panel that was added to the collection.

Adds a ToolBarButton to the collection.

Returns: Int32. The zero-based index of the item in the collection.

Throws:

• ArgumentNullException The ToolBarButton being added to the collection is null.

• ArgumentException The parent of the ToolBarButton specified in the button parameter is not null.

Adds an array of ToolBarButton to the collection.

Removes all ToolBarButton objects from the collection.

Removes and optionally disposes all ToolBarButton objects from the collection.

Determines whether the specified ToolBarButton is located within the collection.

Returns: Boolean. true if the ToolBarButton is located within the collection; otherwise, false.

Determines whether the collection contains a ToolBarButton with the specified key.

Returns: Boolean. true to indicate the collection contains a ToolBarButton with the specified key; otherwise, false.

Returns an enumerator to use to iterate through the ToolBarButton objects in the collection.

Returns: IEnumerator. An IEnumerator that represents the item collection.

Returns the index within the collection of the specified ToolBarButton.

Returns: Int32. The zero-based index where the ToolBarButton is located within the collection; otherwise, negative one (-1).

Returns the index of the first occurrence of a ToolBarButton with the specified key.

Returns: Int32. The zero-based index of the first occurrence of the ToolBarButton with the specified key, if found; otherwise, -1.

Inserts the specified ToolBarButton into the collection at the specified index.

Throws:

• ArgumentNullException The button parameter is null.

• ArgumentException The button parameter's parent is not null.

• ArgumentOutOfRangeException The index parameter is less than zero or greater than the value of the Count property of the ToolBarButtonCollection class.

Removes the specified ToolBarButton from the collection.

Throws:

• ArgumentNullException The ToolBarButton assigned to the button parameter is null.

Removes the ToolBarButton located at the specified index within the collection.

Throws:

• ArgumentOutOfRangeException The index parameter is less than zero or greater than or equal to the value of the Count property of the ToolBarButtonCollection class.

Removes the ToolBarButton with the specified key from the collection.

Renders the list to the json definition for the client.

Returns: Object.

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents a toolbar component.

public class ToolBar : Control, IWisejDesignTarget

Public Class ToolBar
    Inherits Control
    Implements IWisejDesignTarget

Constructors

ToolBar()

Initializes a new instance of the class.

Properties

AutoOverflow

: Enables the overflow handling which automatically removes items that don't fit in the and adds them to a drop-down menu button. (Default: True)

AutoSize

Methods

Returns a collection of referenced components or collection of components.

Processes the event from the client.

Renders the client component.

Validates the current control.

Events

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Specifies the style of the button in a control.

public enum ToolBarButtonStyle : Enum

Public Enum ToolBarButtonStyle As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Specifies how a in a control behaves when the control resizes.

public enum ToolBarButtonSizeMode : Enum

Public Enum ToolBarButtonSizeMode As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the method that will handle the event of a .

public delegate void ToolBarButtonClickEventHandler(Object sender, ToolBarButtonClickEventArgs e)

Public Delegate Sub ToolBarButtonClickEventHandler(ByVal sender As [Object], ByVal e As ToolBarButtonClickEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Specifies the alignment of text on the control.

public enum ToolBarTextAlign : Enum

Public Enum ToolBarTextAlign As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Component

  • Component

    • BindableComponent

      • ToolBarButton

Represents an item in the ToolBar.

public class ToolBarButton : BindableComponent, ICommandSource

Public Class ToolBarButton
    Inherits BindableComponent
    Implements ICommandSource

Change the type of item to display using the Style property.

Constructors

ToolBarButton()

Initializes a new instance of the ToolBarButton class.

ToolBarButton(text)

Initializes a new instance of the ToolBarButton class and displays the assigned text on the button.

Properties

Boolean: Returns or sets a value indicating that the control can display HTML in the Text property. (Default: False)

String: Sets the appearance key for the theme engine. (Default: null)

Boolean: Returns or sets whether the application blocks the browser with a modal mask when this button is clicked and until the server is done processing the execution request. (Default: False)

AutoShowLoader blocks the entire browser as soon as the button is clicked since it's implemented on the client side, while ShowLoader blocks the specific widget when returning from the request.

ICommand: Returns or sets the ICommand implementation to invoke. (Default: null)

ContextMenu: Returns or sets the menu to be displayed in the drop-down toolbar button. (Default: null)

Boolean: Returns or sets whether the button is enabled. (Default: True)

Color: Returns or sets the text color of the toolbar button.

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

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

Throws:

• ArgumentOutOfRangeException The specified index is less than -1.

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

ImagePropertySettings: Creates the property manager for the Image properties on first use.

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

Padding: Returns or sets the space between toolbar buttons.

String: Returns or sets the name of the ToolBarButton.

Padding: Returns or sets padding within the toolbar button.

ToolBar: Returns the toolbar control that the toolbar button is assigned to.

Boolean: Returns or sets whether a toggle-style toolbar button is currently in the pushed state. (Default: False)

ToolBarButtonSizeMode: Returns or sets how the toolbar button is resized. (Default: Auto)

ToolBarButtonStyle: Returns or sets the style of the toolbar button. (Default: PushButton)

Object: Returns or sets the object that contains data about the toolbar button. (Default: null)

String: Returns or sets the text displayed on the toolbar button. (Default: "")

When AllowHtml is set to true, the text can contain HTML content. If the text contains new lines (CRLF) but doesn't contain HTML elements (at least one "<") all CRLF are automatically substituted with "<br/>".

String: Returns or sets the text that appears as a ToolTip for the button. (Default: "")

Boolean: Returns or sets whether the toolbar button is visible or hidden. (Default: True)

Methods

Releases the resources used by the ToolBarButton.

Returns a collection of referenced components or collection of components.

Fires the Click event.

Fires the CommandChanged event.

Fires the PushedChanged event.

Renders the client component.

Generates the Click and ButtonClick events.

Updates the component on the client. Overridden to repaint the toolbar in design mode.

Validates the current control.

Returns: Boolean. true if the active control is validated.

Events

EventHandler Fired when the control is clicked.

EventHandler Fired when the Command property value changes.

EventHandler Fired when the Pushed property value changes.

Implements