Custom Button Properties

These custom properties control specific types of controls created by Iron Speed Designer.  Generally you should not modify these properties; all configurations should be made using Button Action dialogs.

Property

Description

Consumers

Designates a “consumer” of the button event.  When the button is activated, the application creates an “event” that informs other controls that the button has been clicked.  This allows other controls to take action based on the event.  This property designates which component, if any, receives the event.

None

There is no consumer of this event.

Page

The page consumes this event, indicating that all records on the page should be updated.

Parent

The parent control consumes this event.

ParentRecord

The parent record consumes this event.

ParentTable

The parent table consumes this event.

Control name

The actual control bound to the button, e.g.: CategoriesTableControl.

ControlToUpdate

Specifies the name of the dropdown list control updated by this button.

Applies To

Button
ImageButton
LinkButton

FieldValue

Specifies the name of the database field that populates the dropdown list updated by the Quick Add button.

Applies To

Button
ImageButton
LinkButton

RedirectArgument

URL arguments, if any, to pass to the page being displayed.  There are several special arguments described in Button Actions - Substitution Variables.

RedirectURL

The URL of the page to be displayed when the button is clicked.  There are several special arguments:

Back

This argument can be used with the special RedirectArgument "updatedata", which is related to page history (Back key) handling.

You can modify a page’s OK or Cancel button to return "Back" to a previous page with fresh data by adding a RedirectArgument of "updatedata". This causes the previous page to load with fresh data, while maintaining settings (such as page size displayed, sorting, etc).

RowDisplayAction

Specifies the row display behavior when the ‘Expand’ button is pressed.

ExpandSelectedRow

The selected row is expanded.  No other rows are changed.

ExpandSelectedRowAndCollapseOtherRows

The selected row is expanded and all other rows are collapsed.

SendEmail<Number>From

Specifies the email address to use in the From field of an email.  The email address can be specified as a constant or as a substitution variable.  If it is a substitution variable, then the email address is taken from a field in the Table or Record control during application run-time.  Multiple email addresses should be separated by comas (,).

Email address should take one of these formats:

  • A constant

  • A substitution variable

  • Display name constant <Email address constant>

  • Display name constant <Email address substitution variable>

  • Display name substitution variable <Email address constant>

  • Display name substitution variable <Email address substitution variable>

Substitution variables have the format:

{ControlName:NoUrlEncode:FV:FieldName}

See Button Actions - Substitution Variables for details on substitution variables.

Property numbering starts with 1, must be an integer, and should be sequential.  For example, adding three send email actions using the Button Action Wizard creates this sequence of SendEmail<Number>From properties:

SendEmail1From

SendEmail2From

SendEmail3From

If you are adding custom properties through the Property Sheet, make sure the properties are numbered sequentially.  If numbering is not sequential, then send email code will be created only for those send email actions that are numbered sequentially.  For example, if you have added three send email actions and used numbers 1, 3, 4, send email code will be created only for the first send email action.

Numbering

Send email code is created for

1, 2, 3, 6

1, 2, 3

2, 5, 8

None

The text of all send email related properties is stored as encoded (using URL encoding).  This allows you to use different special characters (for example XML code).  We strongly recommend using the Button Action Wizard to add send email-related properties.  This helps avoid unnecessary problems and assures correct operation of your application.

SendEmail<Number>To

SendEmail<Number>CC

SendEmail<Number>BCC

Specifies the email address to use in the To, CC, and BCC fields of an email.

See SendEmail<Number>From for numbering details.

SendEmail<Number>Subject

Specifies the subject of the email.

See SendEmail<Number>From for numbering details.

SendEmail<Number>ContentURL

Specifies the URL of the web page used as content of the email.

See SendEmail<Number>From for numbering details.

SendEmail<Number>Content

Specifies the text used as content of the email.

See SendEmail<Number>From for numbering details.

SendEmail<Number>EmbedImages

Supplements the SendEmail<Number>ContentURL property.

true

Images are attached to the email.

false

Images and style sheets are referenced by fully qualified URLs

See SendEmail<Number>From for numbering details.

SendEmail<Number>ForRecord

This property is used to create send email actions.

current

Substitution variables are evaluated for the current record of the associated Record control or for first selected record in the associated Table control.

selected

Substitution variables are evaluated for all selected records in the associated Table control.  A separate email is sent for each selected record.

all

Substitution variables are evaluated for all records in the associated Table control.  A separate email is sent for each record.

See SendEmail<Number>From for numbering details.
Properties of buttons within ASCX controls

Properties are declared differently for a Text button (called a ‘theme button’) and an Image button.  For example the CommandName property for a text button is Button-CommandName whereas it is just CommanName for an Image button.

The reason is that theme buttons are usually ASCX controls that are included within a page (ASPX).  A button component creates a reusable panel and is based on a layout that you can specify.  The PushButton, LinkButton and ImageButton are standard HTML buttons.  In order to retrieve the property for any ASCX control within a page, it is essential to prepend the name of the ASCX control before the property so that the page is aware it refers to the property of an ASCX control with that name.  Image buttons, on the other hand, are simple ASP controls and therefore don’t require us to specify the name of the controls before the properties.

The Button uses several properties to set the values of attributes inside of the Button panel.  The properties whose names are prefixed “Button” refer to the attributes within the Button panel.  For example, a code generation tag named Button within the Button.html panel is referred by the name Button by the enclosing page or panel.  As such, the Button-CausesValidation property refers to the CausesValidation property of the code generation tag named “Button” or “LinkButton” within the ThemeButton.ascx control.