ActionUrl.UrlFormatString Property

Specifies the URL of the page to be loaded when executing an ActionUrl Action.

Namespace: DevExpress.ExpressApp.Actions

Assembly: DevExpress.ExpressApp.v18.2.dll

Declaration

C#

public string UrlFormatString { get; set; }

VB.NET

Public Property UrlFormatString As String

Property Value

Type	Description
String	A string value that represents an URL.

Remarks

Below is an example of using this property.

C#

public partial class ViewController1 : ViewController{
   private void InitializeComponent(){
      //...
      this.urlAction1 = new DevExpress.ExpressApp.Actions.ActionUrl(this.components);
      this.urlAction1.UrlFormatString = "http://www.yahoo.com";
      //this.urlAction1.UrlFormatString = "error.aspx";
      //...
   }
}

VB.NET

Public Partial Class ViewController1
      Inherits ViewController
   Private Sub InitializeComponent()
      '...
      Me.urlAction1 = New DevExpress.ExpressApp.Actions.ActionUrl(Me.components)
      Me.urlAction1.UrlFieldName = "http://www.yahoo.com"
      'Me.urlAction1.UrlFieldName = "error.aspx"
      '...
   End Sub
End Class

You can specify the name of a persistent object’s property whose value represents an URL. For details, see ActionUrl.UrlFieldName.

C#

public class DomainObject1 : BaseObject {
   //...
   private string webSite;
   public string WebSite {
      get { return webSite; }
      set { webSite = value; }
   }
}
public partial class ViewController1 : ViewController{
   private void InitializeComponent(){
      //...
      this.urlAction1 = new DevExpress.ExpressApp.Actions.ActionUrl(this.components);
      this.urlAction1.UrlFieldName = "WebSite";
      this.urlAction1.UrlFormatString = "http://{0}";
      //...
   }
}

VB.NET

Public Class DomainObject1
      Inherits BaseObject
   '...
   Private fwebSite As String
   Public Property WebSite() As String
      Get
         Return fwebSite
      End Get
      Set
         fwebSite = Value
      End Set
   End Property
End Class
Public Partial Class ViewController1
      Inherits ViewController
   Private Sub InitializeComponent()
      '...
      Me.urlAction1 = New DevExpress.ExpressApp.Actions.ActionUrl(Me.components)
      Me.urlAction1.UrlFieldName = "WebSite"
      Me.urlAction1.UrlFormatString = "http://{0}"
      '...
   End Sub
End Class

In this instance, the ActionURL should be activated in a List View for each object or in a Detail View. To do that, set the ActionBase.SelectionDependencyType property to the SelectionDependencyType.RequireSingleObject value and the ActionBase.Category property to “RecordEdit”. In a List View, the Action will be displayed in an additional cell for each object.