A newer version of this page is available. Switch to the current version.

ActionUrl Class

An Action which is used to redirect a browser to a specified page.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v18.2.dll


public class ActionUrl :
Public Class ActionUrl
    Inherits ActionBase


The ActionUrl class inherits the basic functionality of Actions Actions from the ActionBase class. URL Actions are intended for ASP.NET applications. In Windows Forms applications, these types of Actions are not supposed to be used.

The ActionUrl is used to invoke a browser and pass an URL to it. To specify the text of this link, use the ActionUrl.TextFormatString property. To specify the URL, use the ActionUrl.UrlFormatString property. Use the ActionUrl.UrlFieldName and ActionUrl.TextFieldName properties to insert a value from the specified property to an URL or to an Action caption (refer to these properties descriptions to see a list of restrictions).

Visual controls for this action can be created by the ActionContainerHolder and ASPxGridViewContextMenu Action Containers. Other containers are not designed to create controls for this Action.

The UrlFieldName and TextFieldName properties are processed only when an Action is shown via a separate grid column. The following example demonstrates how to configure the ActionUrl for this scenario:

ActionUrl urlAction = new ActionUrl(this, "ShowUrlAction", "ListView");
urlAction.SelectionDependencyType = SelectionDependencyType.RequireSingleObject;
urlAction.UrlFieldName = "Text";
urlAction.UrlFormatString = "http://google.com?q={0}";
urlAction.TextFormatString = "Caption for {0}";
urlAction.TextFieldName = "Text";

Alternatively, the ActionUrl Action can be used to show a static URL that is independent from the selected objects:

ActionUrl urlAction = new ActionUrl(this, "ShowUrlAction", "RecordEdit");
urlAction.SelectionDependencyType = SelectionDependencyType.Independent;
urlAction.UrlFormatString = "http://google.com";

The ActionUrl class is not designed for other scenarios.

To create a URL Action, use one of its constructors and pass the parent Controller as a parameter.


See Also