com.aspose.gridweb

Class CustomCommandButton

java.lang.Object

com.aspose.gridweb.Control

com.aspose.gridweb.CustomCommandButton

public class CustomCommandButton
extends Control

Represents a custom command button in the tab bar of the GridWeb control.

Example

 
         GridWebBean GridWeb1=ExtPage.getInstance().getBean();
         CustomCommandButton button = new CustomCommandButton();
         button.setCommand("MyCommand");
         button.setImageUrl("images/button1.gif");
         GridWeb1.getCustomCommandButtons().add(button);
 

Constructor Summary

Constructors

Constructor and Description
CustomCommandButton() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getClientClickEvent() Gets the click event handler at client side.
java.lang.String	getCommand() Gets the command name.
int	getCommandType() Gets the rendering type of the command.
boolean	getDiscardInput() Indicates whether to discard user input at client browser when user click this button.
java.lang.String	getImageUrl() Gets the command button's image url.
java.lang.String	getText() Gets the alternative text of the command button.
java.lang.String	getToolTip() Gets the tooltip of the command button.
Unit	getWidth() Width of the button.
void	setClientClickEvent(java.lang.String value) Sets the click event handler at client side.
void	setCommand(java.lang.String value) Sets the command name.
void	setCommandType(int value) Sets the rendering type of the command.
void	setDiscardInput(boolean value) Indicates whether to discard user input at client browser when user click this button.
void	setImageUrl(java.lang.String value) Sets the command button's image url.
void	setText(java.lang.String value) Sets the alternative text of the command button.
void	setToolTip(java.lang.String value) Sets the tooltip of the command button.
void	setWidth(Unit value) Width of the button.

Methods inherited from class com.aspose.gridweb.Control

getUniqueID, getVisible, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomCommandButton

public CustomCommandButton()

Default constructor.

Method Detail

getCommandType

public int getCommandType()

Gets the rendering type of the command. The type can be command button or context menu item.

See CustomCommandButtonType.

setCommandType

public void setCommandType(int value)

Sets the rendering type of the command. The type can be command button or context menu item.

See CustomCommandButtonType.

getCommand

public java.lang.String getCommand()

Gets the command name.

setCommand

public void setCommand(java.lang.String value)

Sets the command name.

getText

public java.lang.String getText()

Gets the alternative text of the command button.

setText

public void setText(java.lang.String value)

Sets the alternative text of the command button.

getImageUrl

public java.lang.String getImageUrl()

Gets the command button's image url. If sets to null or empty string, the button will only display it's text.

setImageUrl

public void setImageUrl(java.lang.String value)

Sets the command button's image url. If sets to null or empty string, the button will only display it's text.

getToolTip

public java.lang.String getToolTip()

Gets the tooltip of the command button.

setToolTip

public void setToolTip(java.lang.String value)

Sets the tooltip of the command button.

getClientClickEvent

public java.lang.String getClientClickEvent()

Gets the click event handler at client side.

setClientClickEvent

public void setClientClickEvent(java.lang.String value)

Sets the click event handler at client side.

getWidth

public Unit getWidth()

Width of the button.

setWidth

public void setWidth(Unit value)

Width of the button.

getDiscardInput

public boolean getDiscardInput()

Indicates whether to discard user input at client browser when user click this button. Could be used as an "undo" action.

setDiscardInput

public void setDiscardInput(boolean value)

Indicates whether to discard user input at client browser when user click this button. Could be used as an "undo" action.